Skip to main content

1. Get an API key

Apply for an API key on the Elite Prospects developer portal.

2. Make a request

Send your key in the X-Api-Key header. The apiKey query parameter also works. See Authentication for both options.

3. Read the response

Every list endpoint returns the same envelope shape:
data holds the records, _meta describes the page (with totalRecords reflecting matches after access filtering), and _links provides pagination links. Send the X-Api-Key header again when you follow a link.

4. Try a few more endpoints

Next steps

Authentication

Where the key goes and how to keep it safe.

Conventions

Pagination, sorting, field selection.

Coverage

What your plan unlocks.

API reference

Every endpoint, every parameter.