API reference / Launches
Get one launch event
Written and maintained by The ProspectAPIs team
GET/v1/launches/:id
GET /v1/launches/:id is the ProspectAPIs operation getLaunch, in the Launches group of the REST API. One launch event by id. Not available yet: answers 503 and charges nothing until GET /pricing reports launches available; a missing id is a free 404. Cost: Not available yet. Send your API key as a Bearer token in the Authorization header.
How this fits with the rest of the launches API, with worked examples, is in the launch events guide.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id required | path | string (uuid) | A launch id from GET /v1/launches. |
Responses
| Status | Meaning |
|---|---|
| 200 | The launch event. |
| 400 | The request was invalid (e.g. a bad filter or input); nothing was charged. |
| 401 | The API key is missing or invalid. |
| 404 | No launch event with that id. Free. |
| 503 | Launch events are not available yet (GET /pricing launches.available is false). Nothing is charged. |
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.
200 response fields
The launch event.
| Field | Type | Description |
|---|---|---|
| data required | Launch | One launch event. Carries a link to the company's own post or page and derived fields only, never the post text or media. |
| data.id required | string (uuid) | |
| data.stage required | string: post, pre | post: launched and usable now. pre: the company itself says it is about to launch; never a prediction. |
| data.launch_type | string or null: new_company, new_product, major_version, feature, | |
| data.company_name | string or null | |
| data.company_domain required | string | |
| data.product_name | string or null | |
| data.category | string or null | |
| data.country_code | string or null | ISO 3166-1 alpha-2, when known. |
| data.source_url required | string (uri) | The company's own post or page. |
| data.launched_at required | string (date-time) | |
| data.detected_at required | string (date-time) | |
| data.person_ref | string or null | An opaque reference to the founder or poster (per_ plus 24 hex). |
| data.person_name | string or null | The founder's or poster's public name. |
| data.poster_role | string or null: company, founder, employee, | |
| data.gate_version required | string | The relevance gate version that passed this record. |
| data.updated_at | string (date-time) |
| Header | Meaning |
|---|---|
| RateLimit-Limit | Requests this API key may make per minute. |
| RateLimit-Remaining | Requests left in the current one-minute window. |
| RateLimit-Reset | Seconds until the current window resets. |
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/launches/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13 \
-H "Authorization: Bearer $PROSPECTAPIS_KEY"const res = await fetch("https://api.prospectapis.com/v1/launches/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/launches/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 launch events guide covers this area end to end. Previous operation: Search launch events. Next operation: Search a company's ads. 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?