Skip to main content
POST
/
api
/
totaljobs
/
jobs
/
search
/totaljobs/jobs/search
curl --request POST \
  --url https://api.anysite.io/api/totaljobs/jobs/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "text": "<string>",
  "count": 2,
  "timeout": 300,
  "location": "<string>",
  "radius": 1,
  "salary_min": 1,
  "salary_period": "annual"
}
'
[
  {
    "id": 123,
    "title": "<string>",
    "url": "<string>",
    "@type": "@totaljobs_search_item",
    "company_id": 123,
    "company_name": "<string>",
    "company_url": "<string>",
    "company_image": "<string>",
    "location": "<string>",
    "postal_code": "<string>",
    "salary": "<string>",
    "text_snippet": "<string>",
    "is_anonymous": true,
    "is_sponsored": true,
    "is_cross_posted": true,
    "source_site": "<string>",
    "published_at": "<string>",
    "global_id": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
text
string
required

Search query — job title, skill, or company name

Minimum string length: 1
​
count
integer
required

Max number of jobs to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
location
string | null

City, town, or postal code

​
radius
integer | null

Search radius around the location in miles

Required range: x >= 0
​
date_posted
enum<string> | null

Restrict to recently posted jobs

Available options:
last_24h,
last_3_days,
last_7_days,
last_14_days
​
company_type
enum<string> | null

Restrict to direct employers or recruitment agencies

Available options:
direct_employer,
agency
​
job_type
enum<string> | null

Type of employment

Available options:
permanent,
work_from_home,
contract,
part_time,
temporary
​
salary_min
integer | null

Minimum salary threshold (in the chosen period)

Required range: x >= 0
​
salary_period
enum<string>
default:annual

Period the salary_min threshold applies to

Available options:
annual,
daily,
hourly
​
sort
enum<string> | null

Result ordering

Available options:
relevance,
date,
salary_asc,
salary_desc

Response

Successful Response

​
id
integer
required
​
title
string
required
​
url
string
required
​
@type
string
default:@totaljobs_search_item
​
company_id
integer | null
​
company_name
string | null
​
company_url
string | null
​
company_image
string | null
​
location
string | null
​
postal_code
string | null
​
salary
string | null
​
text_snippet
string | null
​
is_anonymous
boolean | null
​
is_sponsored
boolean | null
​
is_cross_posted
boolean | null
​
source_site
string | null
​
published_at
string | null
​
global_id
string | null