Credits

Every API-key request under /data, /analytics and /reference is metered in credits. What a call costs follows from what it returns, so you can price a call before you make it. After the call, the X-Credits-Used response header reports what it consumed. Credits don’t depend on any currency or plan: the same call costs the same number of credits whoever makes it.

Open beta: metered and capped, not billed. Each call draws on your team’s credits, which Dealroom grants when you get API access. When they run out, requests return 402 CREDITS_EXHAUSTED. Allowances are indicative and may change, and credits are not billed in money during open beta.

How a call is priced

Four groups. Free (0), summary (1 per record), full profile (2 per record) and analytics (per query).
A field costs the group of the dataset it comes from. A company’s own name, location and funding total are summary. Its founders, revenue and web traffic are glances at the people, financials and traffic datasets, so they are full profile.
A request is charged at the highest group of any field it returns. One full-profile field makes the whole row full profile.
view=summary returns the summary shape. view=full, the default, adds the full-profile fields. It works on the entity collections and their /similar lenses.

Detail endpoints (/data/companies/{id}) always return, and charge for, the full profile.

Worked example

Here is the same company as a summary row and as a full row. Values are illustrative and trimmed for length.

{
  "uuid": "345d1ab6-33df-4759-9e17-0d0c0ec9ab1c",
  "name": "Stripe",
  "tagline": "Online payment processing for internet businesses",
  "domain": "stripe.com",
  "locations": [{ "role": "hq", "city": { "id": 1001, "name": "San Francisco" } }],
  "taxonomy": [{ "id": 42, "name": "fintech", "type": "industry" }],
  "employees_count": 8000,
  "funding": { "total": 8700000000, "total_vc": 8700000000, "rounds_count": 12 },
  "valuation": { "value": 65000000000, "year": 2024, "month": 2 },
  "jobs": { "is_hiring": true, "open_count": 420 }
}

{
  "uuid": "345d1ab6-33df-4759-9e17-0d0c0ec9ab1c",
  "name": "Stripe",
  "tagline": "Online payment processing for internet businesses",
  "domain": "stripe.com",
  "locations": [{ "role": "hq", "city": { "id": 1001, "name": "San Francisco" } }],
  "taxonomy": [{ "id": 42, "name": "fintech", "type": "industry" }],
  "employees_count": 8000,
  "funding": { "total": 8700000000, "total_vc": 8700000000, "rounds_count": 12 },
  "valuation": { "value": 65000000000, "year": 2024, "month": 2 },
  "jobs": { "is_hiring": true, "open_count": 420 },
  "founders": {
    "total": 2,
    "items": [
      { "is_founder": true, "person": { "name": "Patrick Collison", "type": "person" } },
      { "is_founder": true, "person": { "name": "John Collison", "type": "person" } }
    ]
  },
  "revenue": { "value": 14000000000, "year": 2023 },
  "traffic": { "monthly_visits": 41000000, "growth_3m": 3.1 },
  "patents": { "count": 12 }
}

The full row adds founders, revenue, traffic and patents. Each is a glance at another dataset, so the row is priced at full profile.

Call	Records	Group	Credits
`GET /data/companies?view=summary&limit=25`	25	Summary	25
`GET /data/companies?limit=25`	25	Full profile	50
`GET /data/companies/{id}`	1	Full profile	2
`GET /data/companies/{id}/funding-rounds?limit=10`	10	Summary	10
`GET /analytics/aggregate/funding-rounds?…`	1 query	Analytics	5
`GET /reference/filters/taxonomy_id/values?q=fintech`	—	Free	0

What a call costs

The prices are placeholders during open beta and may be revised. Build against the header, not against the numbers on this page.

Credits per group

A call costs its group’s credits times the records it returns: rows, map points, or one per analytics query. A call is priced at the prices in force when it is made; upcoming changes are listed with the date they take effect.

Data endpoints

Analytics and reference endpoints

Fields that make a row full profile

On these collections, every field not listed is priced at summary. A row that returns any listed field is priced at full profile; view=summary leaves them out. Sub-resources are priced as a whole, in the endpoint tables above.

Reading the header

GET /data/transactions?limit=25
HTTP/1.1 200 OK
X-Credits-Used: 25

GET /data/companies/{id}
HTTP/1.1 200 OK
X-Credits-Used: 2

GET /analytics/aggregate/funding-rounds?…
HTTP/1.1 200 OK
X-Credits-Used: 5

GET /reference/filters/taxonomy_id/values?q=fintech
HTTP/1.1 200 OK
X-Credits-Used: 0

GET /data/companies?limit=99999
HTTP/1.1 400 Bad Request
X-Credits-Used: 0

The value is always a non-negative integer.

Value	Meaning
`N > 0`	This request consumed `N` credits
`0`	A free endpoint (search, filter values, lookups) or an error response — a failed call costs nothing
header absent	The endpoint is not metered, or the request was not authenticated with an API key

0 and absent are deliberately different: 0 means the API metered the call and found it free; absent means it was never metered.

Which responses carry it

Carried: every response — success or error — to a request authenticated with an API key under /data/*, /analytics/* and /reference/*, including 403, 404, 429 and any 400 raised once authentication has completed.
Not carried: /platform/* self-service (account, API keys, usage, teams, lists), /system/*, /health, the API reference itself, the namespace indices (/data, /analytics, /reference), and any response rejected before authentication completes — a 401 for a missing or invalid token, or the 400 for an API-key request without its X-Client-Id header.

The header is listed in Access-Control-Expose-Headers, so browser-side code can read it:

const res = await fetch(`${baseUrl}/data/transactions?limit=25`, { headers });
const raw = res.headers.get("X-Credits-Used");
// null: not metered (or not an API-key request) — keep it distinct from a free call's 0
const credits = raw === null ? null : Number(raw);

Remaining balance

During open beta an API key draws on its team’s credits, granted by Dealroom when you get API access. Your team’s used and remaining credits are shown on the API keys settings page. When they are used up, or if none were granted yet, requests under /data and /analytics return 402 CREDITS_EXHAUSTED until more are added; /reference lookups are free and stay available. The balance trails usage by up to about two minutes, so a few requests past the limit can still succeed. If your team’s credits cannot be checked for a moment, requests return 503 SERVICE_UNAVAILABLE; retry shortly. There is no X-Credits-Remaining header yet. The API only reports a figure it can compute exactly on every replica, and a remaining balance needs a shared consumption counter that does not exist yet.

Rate limits

How fast you can call the API — a separate control from how much you consume.

Errors

The error envelope and every stable error code, including the 402 when credits run out.

Getting Started

Examples

Agents

Concepts

References

How a call is priced

Worked example

What a call costs

Credits per group

Data endpoints

Analytics and reference endpoints

Fields that make a row full profile

Reading the header

Which responses carry it

Remaining balance

Further reading

Rate limits

Errors

​How a call is priced

​Worked example

​What a call costs

​Credits per group

​Data endpoints

​Analytics and reference endpoints

​Fields that make a row full profile

​Reading the header

​Which responses carry it

​Remaining balance

​Further reading

Rate limits

Errors

How a call is priced

Worked example

What a call costs

Credits per group

Data endpoints

Analytics and reference endpoints

Fields that make a row full profile

Reading the header

Which responses carry it

Remaining balance

Further reading