Base Jobs API

Overview

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

Base Jobs API endpoints

Request types

Rate limits

Credits

Base Jobs API endpoints

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

Base Jobs API features two search and one collect endpoint. Use the endpoints with any API-compatible application to retrieve job posting data.

Request type	Endpoint	Function
POST	/v2/job_base/search/filter	Search for relevant job postings using search filters
POST	/v2/job_base/search/filter/preview	Retrieves a small set of partial data using Search Filter queries
POST	/v2/job_base/search/es_dsl	Search for relevant job postings using Elasticsearch DSL schema
POST	/v2/job_base/search/es_dsl/preview	Retrieves a small set of partial data using Elasticsearch DSL queries
GET	/v2/job_base/collect/{job_id}	Collect job posting data using IDs

Bulk Collect

Bulk Collect (Bulk API) expands Base Jobs API's functionality and features two POST and two GET endpoints.

Request type	Endpoint URL and function
POST	/v2/data_requests/job_base/id_file
POST	/v2/data_requests/job_base/filter
GET	/v2/data_requests/{data_request_id}/files
GET	/v2/data_requests/{data_request_id}/files/{file_name}

Request types

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

Jobs data API supports two types of requests:

• Search endpoints support POST requests only.

• Collect endpoints support the GET requests only.

Request type	Endpoint
POST	/v2/job_base/search/filter
POST	/v2/job_base/search/filter/preview
POST	/v2/job_base/search/es_dsl
POST	/v2/job_base/search/es_dsl/preview
GET	/v2/job_base/collect/{job_id}

Rate limits

Base Jobs API endpoints restrict the number of requests allowed per second.

Search endpoints

Collection endpoint

Bulk Collect search and collection endpoints

18 requests per second

54 requests per second

27 requests per second

Credits

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

• /v2/job_base/search/filter

• /v2/job_base/search/filter/preview

• /v2/job_base/search/es_dsl

• /v2/job_base/search/es_dsl/preview

One collect credit is deducted for one successful (200) request in the collection endpoint:

• /v2/job_base/collect/{job_id}

---

Read more about the credits in the following topic:

General information about credits