Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.beta.dealroom.co/llms.txt

Use this file to discover all available pages before exploring further.

The shortest end-to-end query you can run against the Dealroom API. Authenticates with your M2M API key, fetches the 10 most-funded companies tagged fintech, and prints them. Adapt by swapping the industry, sort key, or limit — every other example in this site builds on the same primitives.
The Dealroom API filters industries by numeric tag ID, not by name. Look up the ID for your target industry first:
curl "https://api-next.beta.dealroom.co/api/filters/tag_id/values?q=fintech&type=industry" \
  -H "Authorization: Bearer $ACCESS_TOKEN"
The response includes id fields — use those in tag_id[in_any]:<id> expressions. The snippets below use <FINTECH_TAG_ID> as a placeholder.

​
Prerequisites

  • A Dealroom M2M API key. See Authentication to create one.
  • DEALROOM_CLIENT_ID and DEALROOM_CLIENT_SECRET exported as environment variables.
  • jq for the cURL snippet (token extraction and output formatting). The Node.js and Python variants don’t require it.

​
The recipe

# 1. Exchange credentials for a Bearer token
ACCESS_TOKEN=$(curl -s -X POST "https://accounts.beta.dealroom.co/oauth/token" \
  -H "Content-Type: application/json" \
  -d "{
    \"client_id\": \"$DEALROOM_CLIENT_ID\",
    \"client_secret\": \"$DEALROOM_CLIENT_SECRET\",
    \"audience\": \"https://api-next.beta.dealroom.co\",
    \"grant_type\": \"client_credentials\"
  }" | jq -r '.access_token')

# 2. Fetch + print the top 10
curl -s "https://api-next.beta.dealroom.co/api/entities?filter=tag_id[in_any]:<FINTECH_TAG_ID>&sort=-total_funding&limit=10" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Client-Id: $DEALROOM_CLIENT_ID" \
  | jq -r '.data[] | "\(.name) — $\(.funding_summary.total_funding // 0)"'

​
Expected output

Stripe — $9,123,000,000
Klarna — $4,500,000,000
Revolut — $1,700,000,000
...
Exact companies and amounts will vary as new funding events land in the dataset.

​
What this example covers

ConceptWhere it shows up
OAuth2 client-credentials grantThe token-exchange step
Required headersAuthorization, X-Client-Id
Filter expressionfilter=tag_id[in_any]:<FINTECH_TAG_ID>
Sort with descending directionsort=-total_funding
Paginationlimit=10 (use offset for subsequent pages)
Optional fieldsfunding_summary.total_funding may be null — coalesce

​
Where to go from here

  • Swap the tag ID for any other industry — use /api/filters/tag_id/values?type=industry to discover tag IDs. See the Filters reference for the full operator list.
  • Combine filters with and() / or() — see Filtering.
  • Compute totals or rankings server-side instead of paging — see Aggregates.
  • Build a full dashboard around this data — see the Portfolio Dashboard example.