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

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Base Jobs API endpoints</td><td><a href="#base-jobs-api-endpoints">#base-jobs-api-endpoints</a></td></tr><tr><td>Request types</td><td><a href="#request-types">#request-types</a></td></tr><tr><td>Rate limits</td><td><a href="#rate-limits">#rate-limits</a></td></tr><tr><td>Credits</td><td><a href="#credits">#credits</a></td></tr></tbody></table>

## Base Jobs API endpoints

{% hint style="info" %}
Our API is a data retrieval tool. The endpoints do not support analytic features.
{% endhint %}

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

{% hint style="warning" %}
All Jobs data API requests must be made over HTTPS. Requests made over HTTP will fail or be redirected to HTTPS.
{% endhint %}

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.

{% columns %}
{% column %}
Search endpoints

Collection endpoint

Bulk Collect search and collection endpoints
{% endcolumn %}

{% column %}
18 requests per second

54 requests per second

27 requests per second
{% endcolumn %}
{% endcolumns %}

## 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:

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>General information about credits</td><td><a href="../api-introduction/credits">credits</a></td></tr></tbody></table>
