> ## Documentation Index
> Fetch the complete documentation index at: https://developers.dealroom.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get started with the Dealroom API in under 5 minutes. Obtain an access token, make your first request, and explore entity search results.

## Prerequisites

* A Dealroom API key. See [Authentication](/mintlify/getting-started/authentication) to obtain one.
* An HTTP client (`curl`, Postman, or any language with an HTTP library).

## 1. Obtain an access token

Exchange your API key credentials for a Bearer token:

```bash theme={null}
curl -X POST https://accounts.dealroom.co/oauth/token \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "audience": "https://api-next.dealroom.co",
    "grant_type": "client_credentials"
  }'
```

The response contains an `access_token` valid for `expires_in` seconds (typically 86400s / 24h).
Cache it and reuse it — do not request a new token per API call.

## 2. Query entities

Fetch the 10 highest-valued startups launched in 2020 or later:

```bash theme={null}
curl "https://api-next.dealroom.co/api/data/entities?sort=-latest_valuation&limit=10&filter=launch_date[gte]:2020" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Client-Id: YOUR_CLIENT_ID"
```

<Tip>
  The `X-Client-Id` header is **required** on all requests authenticated with an
  API key. See [Authentication](/mintlify/getting-started/authentication) for
  details.
</Tip>

## 3. Understand the response

```json theme={null}
{
  "data": [
    {
      "id": 3009626,
      "uuid": "345d1ab6-33df-4759-9e17-0d0c0ec9ab1c",
      "name": "Example Corp",
      "type": "organization",
      "launch_year": 2021,
      "hq_country": "United States",
      "hq_city": "San Francisco",
      "lat": 37.7878,
      "lon": -122.4032,
      "latest_valuation": {
        "value": "5000000000.00",
        "year": 2026,
        "month": 4
      },
      "tags": [
        { "id": 202, "name": "Artificial Intelligence", "type": "technology" }
      ]
    }
  ],
  "page": { "limit": 10, "offset": 0 },
  "currency": "USD"
}
```

* `data` — array of matching entities. Entities expose flat HQ fields (`hq_country`, `hq_city`, `lat`, `lon`) and structured sub-objects like `latest_valuation` and `tags`. Monetary values come back as strings to preserve precision.
* `page.limit` / `page.offset` — the applied pagination params
* `page.total` — total matching records; only present when `include_total=true`
* `currency` — the currency monetary fields are expressed in (defaults to `USD`; override with `?currency=EUR`)

## 4. Paginate through results

Use `limit` and `offset` to page through results:

```bash theme={null}
# Page 2 (records 11-20)
curl "https://api-next.dealroom.co/api/data/entities?sort=-latest_valuation&limit=10&offset=10" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Client-Id: YOUR_CLIENT_ID"
```

See [Pagination](/mintlify/concepts/pagination) for the full reference.

## Next steps

* Learn about [Filtering](/mintlify/concepts/filtering) to narrow results with 65+ available filters.
* Explore [API Versioning](/mintlify/concepts/versioning) to understand how breaking changes are handled.
* Browse the [API Reference](/api-reference) for all available endpoints.