jobdata API Documentation
Get started with our simple jobdata API and be ready to fetch live jobs within minutes.
OpenAPI Schema + Redoc/Swagger UI
You can find the schema documentation in OpenAPI 3.0 format as well as a basic interactive Redoc and Swagger UI below:
To generate API client libraries, documentation and configuration automatically from the OpenAPI schema you might want to check out OpenAPI Generator
Endpoint Documentation
To access an endpoint without the hourly rate limit, you need to include the Authorization
header with the value Api-Key YOUR_API_KEY
, where YOUR_API_KEY
should be replaced with your actual API key. For quick testing you can add your API key via the api_key
GET parameter to every request instead, but make sure you don't leave traces of it in your browser history or simply create a new API key afterwards.
You can generate an API key from your dashboard if you're a subscribed customer. If you haven't subscribed yet please check our pricing page and hit Subscribe now on the plan that best suits your needs.
Currently there are three plans available for subscription, the access, access pro and the access ultra plan. When a feature or endpoint requires the pro or ultra plan it will be indicated by showing an access pro or access ultra badge next to it.
Overview
The following is a comprehensive list of documentation pages for every API endpoint:
-
Job Regions API Endpoint Documentation
Job data
A list of regions available for job search.
-
Job Countries API Endpoint Documentation
Job data
A list of countries available for job search.
-
Job States API Endpoint Documentation
Job data
A list of states available for job search.
-
Job Cities API Endpoint Documentation
Job data
A list of cities available for job search.
-
Jobs API Endpoint Documentation
Job data
Fetching job listings with advanced filters.
-
Job Types API Endpoint Documentation
Job data
A list of job types available for job search.
-
Full-Text Search on Job Descriptions
Job data
access pro
Leverage precise text queries to navigate millions of job descriptions.
-
Jobs Expired API Endpoint Documentation
Job data
access pro
Tracking the lifecycle of job postings.
-
Companies API Endpoint Documentation
Company data
access pro
Accessing detailed company profiles.
-
Industries API Endpoint Documentation
Company data
A list of industries available for company search.
-
Company Types API Endpoint Documentation
Company data
A list of company types available for company search.
-
CSV File Downloads Documentation
Job data
Company data
access ultra
Full job data download infos and sample files.
Also check out our tutorials section for a collection of quick guides and example use cases.
Rate limits
All API endpoints are publicly acessible, except some parameters or queries for attributes that require a certain subscription. Without a valid API key there is a maximum of about 10 requests per hour that can be made for testing purposes. This should be sufficient to get a sneak peek into how the API works and what the response structures look like.
Besides throttling for anonymous requests there are no special limitations for authorized calls to the API. The only restriction is that a client should not send more than 5 requests per second to API endpoints (and max. 50 req/s for static files like company images) and must not make any requests in parallel (sequential requests/processing only!). This is more of a technical measure to avoid peak loads and flooding the API with too many requests at once, especially as some queries can become quite complex and may take a bit longer to process.