API reference / Funding
Read one funding round
Written and maintained by The ProspectAPIs team
GET/v1/funding/:id
GET /v1/funding/:id is the ProspectAPIs operation getFunding, in the Funding group of the REST API. One funding round by id. Costs one record when found; a 404 is free. Cost: $0.02 when found, free on 404. Send your API key as a Bearer token in the Authorization header.
How this fits with the rest of the funding API, with worked examples, is in the funding signals guide.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id required | path | string (uuid) | A UUID. |
Responses
| Status | Meaning |
|---|---|
| 200 | The funding round. |
| 400 | The request was invalid (e.g. a bad filter or input); nothing was charged. |
| 401 | The API key is missing or invalid. |
| 402 | Out of credits and free records. The body carries top_up_url. |
| 404 | No such record for this account. |
| 429 | Too many requests; retry after the window. |
Every error answers with the same JSON body, an error string and sometimes a code; the errors page lists each status and when it happens. A per-key 429 carries Retry-After; see rate limits.
200 response fields
The funding round.
| Field | Type | Description |
|---|---|---|
| data required | FundingRecord | A single funding round. Fields that are unknown for a round are null. |
| data.id required | string (uuid) | |
| data.company_name required | string | |
| data.company_domain | string or null | |
| data.event_class | string or null | The kind of event, e.g. a funding round. |
| data.round_label | string or null | The human round label, e.g. "Series A". |
| data.round_stage | string or null | The normalised round stage, e.g. "series_a" (the value round filters on). |
| data.amount_usd | number or null | The round size in USD, when known. |
| data.amount_original | number or null | The round size in its original currency, when it was not USD. |
| data.currency | string or null | The original currency code for amount_original. |
| data.announced_at required | string (date) | The announcement date (the sort key). |
| data.investors | array of string or null | |
| data.lead_investors | array of string or null | |
| data.country | string or null | The headquarters location as the source states it, often a city or a state. |
| data.country_code | string or null | The headquarters country as an ISO 3166-1 alpha-2 code, such as US. Null when the location is unknown, ambiguous or names two countries. |
| data.source_url | string (uri) or null | The public announcement a buyer verifies against. |
| data.attributes | object or null | Extra, source-dependent fields. |
| data.updated_at | string (date-time) or null |
| Header | Meaning |
|---|---|
| X-Credits-Remaining | USD credits left after this call settles. |
| X-Free-Records-Remaining | Free records left this month after this call settles. |
Code samples
Each sample sends the same request. Set PROSPECTAPIS_KEY in your environment first. Values come from the spec's examples; replace them with your own.
curl https://api.prospectapis.com/v1/funding/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13 \
-H "Authorization: Bearer $PROSPECTAPIS_KEY"const res = await fetch("https://api.prospectapis.com/v1/funding/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13", {
headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}` },
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);import os, requests
res = requests.get(
"https://api.prospectapis.com/v1/funding/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13",
headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
timeout=30,
)
res.raise_for_status()
data = res.json()
print(data)Billing
Billing reserves before it serves: the call holds what it may cost, serves at most what that hold covers, and refunds the rest when the response closes. Any non-2xx answer refunds the whole hold, so a failed call costs nothing. The response reports your balance in X-Credits-Remaining.
Related
The funding signals guide covers this area end to end. Previous operation: Search funding rounds. Next operation: Start a research brief. Every operation, grouped by area, is on the API reference index.
Create a free account to get a key, then run the samples above with your own values.
Was this page helpful?