Multi-source API
Our API is a data retrieval tool. The endpoints do not support analytic features.
Multi-source API features one search and two collect endpoints for searching and collecting relevant Multi-source Company data.
Function | Endpoint |
|---|---|
POST | /v1/multi_source/company/search/es_dsl |
GET | /v1/multi_source/company/collect/{company_id} |
GET | /v1/multi_source/company/collect/{shorthand_name} |
All Multi-source API requests must be made over HTTPS. Requests made over HTTP will fail.
Multi-source API supports two types of requests:
- Search endpoints support POST HTTP requests only.
- Collect endpoints support the GET HTTP requests only.
Request type | Endpoint | Function |
|---|---|---|
POST | /v1/multi_source/company/search/es_dsl | Search for relevant company data using Elasticsearch DSL schema |
GET | /v1/multi_source/company/collect/{company_id} | Collect Multi-source company data using IDs |
GET | /v1/multi_source/company/collect/{shorthand_name} | Collect Multi-source company data using shorthand names* |
*📌 Full profile URL example: www.professional-network.com/company/example-company. Shorthand name example: example-company.
The Multi-source API endpoints restrict the number of requests allowed per second for each client's API token.
Multi-source API search endpoint
Multi-source API collection endpoints
Allows 18 requests per second.
Allow 54 requests per second.
To start using our API, you need a (JWT) token. Your account manager or sales will generate the token for you upon your request for the API plan.
All requests to the Multi-source API must contain an Authorization header that consists of a Bearer authentication string and the JSON Web Token (JWT).
Use any API-compatible tool to authorize and start querying in the API.
If you're unsure where to begin, follow the Postman authorization tutorial:
The token issued for you has a set amount of search and collect credits.
Two search credits are deducted for one successful (200) request in the search endpoint:
- /v1/multi_source/company/search/es_dsl
Two collection credits are deducted for one successful (200) request in the collection endpoints:
- /v1/multi_source/company/collect/{company_id}
- /v1/multi_source/company/collect/{shorthand_name}
Discuss your credit needs with your account manager.
Every search and collect response contains an X-Credits-Remaining header that shows the number of credits left in your account.
You can find the credit balance by clicking Headers in the Postman application.
Example of remaining credits header: