Jobs Data API

12min

This section covers general details about Jobs data API. Follow the links inside the topics to find out more details on the API and its endpoints.

Jobs data API endpoints

Our API is a data retrieval tool. The endpoints do not support analytic features.

Jobs data API features two search and one collect endpoints. Use the endpoints with any API-compatible application to retrieve Professional Network Job posting data.

Endpoint and function

/v1/professional_network/job/search/filter [Search]

/v1/professional_network/job/search/es_dsl [Search]

/v1/professional_network/job/collect/{job_id} [Collect]

Bulk API (Bulk collect) expands on Jobs data API's functionality and consists of two POST and two GET endpoints. It allows you to perform batch searches and data collection using ID lists, search filters, or ES DSL queries.

Endpoint URL/function

/v1/professional_network/job/bulk_collect/id_file [POST]

/v1/professional_network/job/bulk_collect/filter [POST]

/v1/bulk_collect/{data_request_id}/files [GET]

/v1/bulk_collect/{data_request_id}/files/{file_name} [GET]

Available formats

Coresignal provides JSON and CSV formats in Self-service and API (Swagger UI). The CSV format is only available while using Bulk Collect endpoints.

Read more about Bulk Collect in the following articles:

Request types

All Jobs data API requests must be made over HTTPS. Requests made over HTTP will fail.

Jobs data 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

Search for relevant job postings using search filters

POST

Search for relevant job postings using Elasticsearch DSL schema

GET

Collect Job posting data using IDs

Rate limits

Jobs data API endpoints restrict the number of requests allowed per second for each client's API token.

Jobs data API search endpoints

Jobs data API collection endpoints

Bulk Collect POST endpoints

Bulk Collect GET endpoints

Allow 18 requests per second.

Allow 54 requests per second.

Allow 27 requests per second.

Allow 27 requests per second.

Authorization

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. You can also get the token from Coresignal's self-service platform.



All requests to the Jobs data API must contain an Authorization header that consists of a Bearer authentication string and the JSON Web Token (JWT).

Authorization header
Authorization header

Python
Ruby
Node.js
PHP


Use any API-compatible tool to authorize and start querying in the API. If you're unsure where to begin, check out the Postman authorization tutorial:

Credits and tokens

The token issued for you has a set amount of search and collect credits.

One search credit is deducted for one successful (200) request in the search endpoints:

  • /v1​/professional_network/job/search​/filter
  • /v1/professional_network/job/search/es_dsl


One collect credit is deducted for one successful (200) request in the collection endpoint /v1/professional_network/job/collect/{job_id}.

Remember that making one Bulk Collect request will consume more credits as you get bigger data batches.

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 Postman.

Document image


Example of remaining credits header:

JSON


Data dictionaries and samples

Explore what data points we offer in our API jobs data:



Updated 09 Dec 2024
Did this page help you?