Skip to main content

​
Prerequisites

  • A Dealroom API key. See 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: 
curl -X POST https://$AUTH0_DOMAIN/oauth/token \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "audience": "https://api.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 the last 5 years: 
curl "https://api.dealroom.co/api/entities?sort=-valuation&limit=10&filter[launch_year][gte]=2020" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "User-Agent: MyApp/1.0 (you@example.com)" \
  -H "X-Client-Id: YOUR_CLIENT_ID"
The User-Agent and X-Client-Id headers are required on all requests authenticated with an API key. See Authentication for details.

​
3. Understand the response

{
  "data": [
    {
      "id": "abc-123",
      "name": "Example Corp",
      "launch_year": 2021,
      "valuation": 5000000000,
      "hq_locations": [{ "city": "London", "country": "United Kingdom" }],
      "industries": ["fintech", "payments"]
    }
  ],
  "meta": {
    "total": 1482,
    "limit": 10,
    "offset": 0
  }
}
  • data — array of matching entities
  • meta.total — total matching records (used for pagination)
  • meta.limit / meta.offset — the applied pagination params

​
4. Paginate through results

Use limit and offset to page through results: 
# Page 2 (records 11-20)
curl "https://api.dealroom.co/api/entities?sort=-valuation&limit=10&offset=10" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "User-Agent: MyApp/1.0 (you@example.com)" \
  -H "X-Client-Id: YOUR_CLIENT_ID"
See Pagination for the full reference.

​
Next steps

  • Learn about Filtering to narrow results with 65+ available filters.
  • Explore API Versioning to understand how breaking changes are handled.
  • Browse the API Reference for all available endpoints.