API reference
API reference
Written and maintained by The ProspectAPIs team
The ProspectAPIs API reference is a set of pages, one for each of the 15 operations in our OpenAPI spec, grouped as Funding, Research, Watchlists, Account, Meta. Each page shows the method and path, the parameters and request body, the response codes and fields, what the call costs, and curl, JavaScript and Python samples, all generated from the same spec this site serves at /openapi.json.
11 of the 15 operations never cost a credit. New to the API? Start with the quickstart, then authentication and errors.
Funding
Search and read funding rounds.
| Operation | Endpoint | Cost |
|---|---|---|
| Search funding rounds | GET /v1/funding | $0.02 per record, after 100 free a month |
| Read one funding round | GET /v1/funding/:id | $0.02 when found, free on 404 |
Research
Start and poll cited prospect research briefs.
| Operation | Endpoint | Cost |
|---|---|---|
| Start a research brief | POST /v1/research | $0.15 per completed brief, refunded on failure |
| Poll a research brief | GET /v1/research/:id | free, owner only |
Watchlists
Saved funding filters that push new matches to a webhook.
| Operation | Endpoint | Cost |
|---|---|---|
| List watchlists | GET /v1/watchlists | free |
| Create a watchlist | POST /v1/watchlists | free; $0.02 per delivered record |
| Read a watchlist | GET /v1/watchlists/:id | free |
| Delete a watchlist | DELETE /v1/watchlists/:id | free |
| Send a test delivery | POST /v1/watchlists/:id/test | free, 5 a minute per account |
| List recent deliveries | GET /v1/watchlists/:id/deliveries | free |
Account
Your balance, feedback and the API version.
| Operation | Endpoint | Cost |
|---|---|---|
| Account balance | GET /v1/account | free |
| Send feedback | POST /v1/feedback | free, 10 an hour |
| API version | GET /v1/version | free, no key |
Meta
Keyless endpoints: the price list and liveness.
| Operation | Endpoint | Cost |
|---|---|---|
| Live price list | GET /pricing | free, no key |
| Liveness | GET /health | free, no key |
The OpenAPI spec
The whole contract is one OpenAPI 3.1 document at https://prospectapis.com/openapi.json. Import it into Postman or Insomnia, or generate a typed client from it. It describes shapes, not prices; prices come from GET /pricing and your balance from GET /v1/account.
Create a free account to get a key, then copy any sample from an operation page. To see several of these calls chained into one workflow, read researching prospects with an AI agent.