Indeed search API

Search Indeed jobs

curl --request POST \
  --url https://api.stophy.dev/v1/indeed/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "data analyst",
  "location": "Chicago, IL"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'data analyst', location: 'Chicago, IL'})
};

fetch('https://api.stophy.dev/v1/indeed/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/indeed/search"

payload = {
    "query": "data analyst",
    "location": "Chicago, IL"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "jobUrl": "<string>",
        "salaryIsEstimate": true,
        "isRemote": true,
        "isEasyApply": true,
        "isUrgent": true,
        "jobId": "<string>",
        "title": "<string>",
        "companyName": "<string>",
        "companyUrl": "<string>",
        "companyAvatarUrl": "<string>",
        "companyWebsite": "<string>",
        "companyIndustry": "<string>",
        "companyEmployeesText": "<string>",
        "companyRevenueText": "<string>",
        "companyDescription": "<string>",
        "addressFull": "<string>",
        "addressCity": "<string>",
        "addressRegion": "<string>",
        "addressPostalCode": "<string>",
        "addressCountry": "<string>",
        "latitude": 0,
        "longitude": 0,
        "salaryMin": 123,
        "salaryMax": 123,
        "salaryPeriod": "hour",
        "salaryCurrency": "<string>",
        "jobTypes": [
          "fullTime"
        ],
        "attributes": [
          "<string>"
        ],
        "publishedAt": "2023-11-07T05:31:56Z",
        "indexedAt": "2023-11-07T05:31:56Z",
        "applyUrl": "<string>",
        "source": "<string>",
        "description": "<string>"
      }
    ],
    "cursor": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "agentCodeCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "agentCodeCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

indeed

Search Indeed jobs

curl --request POST \
  --url https://api.stophy.dev/v1/indeed/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "data analyst",
  "location": "Chicago, IL"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: 'data analyst', location: 'Chicago, IL'})
};

fetch('https://api.stophy.dev/v1/indeed/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/indeed/search"

payload = {
    "query": "data analyst",
    "location": "Chicago, IL"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "jobUrl": "<string>",
        "salaryIsEstimate": true,
        "isRemote": true,
        "isEasyApply": true,
        "isUrgent": true,
        "jobId": "<string>",
        "title": "<string>",
        "companyName": "<string>",
        "companyUrl": "<string>",
        "companyAvatarUrl": "<string>",
        "companyWebsite": "<string>",
        "companyIndustry": "<string>",
        "companyEmployeesText": "<string>",
        "companyRevenueText": "<string>",
        "companyDescription": "<string>",
        "addressFull": "<string>",
        "addressCity": "<string>",
        "addressRegion": "<string>",
        "addressPostalCode": "<string>",
        "addressCountry": "<string>",
        "latitude": 0,
        "longitude": 0,
        "salaryMin": 123,
        "salaryMax": 123,
        "salaryPeriod": "hour",
        "salaryCurrency": "<string>",
        "jobTypes": [
          "fullTime"
        ],
        "attributes": [
          "<string>"
        ],
        "publishedAt": "2023-11-07T05:31:56Z",
        "indexedAt": "2023-11-07T05:31:56Z",
        "applyUrl": "<string>",
        "source": "<string>",
        "description": "<string>"
      }
    ],
    "cursor": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "agentCodeCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "agentCodeCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Endpoint: indeed.search
Returns: data has results.
Cost: 1 credit per call. Failed calls cost nothing.
Paging: Yes. Send the cursor from the response to get the next page. See Page through results.

Example

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.indeed.search({ query: "data analyst", location: "Chicago, IL" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.indeed.search(query="data analyst", location="Chicago, IL")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/indeed/search \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"query":"data analyst","location":"Chicago, IL"}'

stophy indeed search "data analyst" --location "Chicago, IL"

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

query

string

Maximum string length: 200

location

string

City, region or postal code, e.g. Kansas City, MO. Only jobs within about 5 miles are returned, so a city on a state line stays in its own state.

Required string length: 2 - 200

country

enum<string>

default:us

ISO 3166-1 alpha-2 country code, e.g. us. Any case is accepted.

Available options:

us,

gb,

ca,

au,

nz,

ie,

in,

sg,

my,

ph,

za,

ng,

ae,

sa,

qa,

kw,

bh,

om,

pk,

hk,

jp,

kr,

tw,

cn,

id,

th,

vn,

de,

at,

ch,

fr,

be,

nl,

lu,

es,

pt,

it,

gr,

pl,

cz,

hu,

ro,

fi,

se,

no,

dk,

ua,

tr,

il,

eg,

ma,

mx,

br,

ar,

cl,

co,

pe,

ec,

uy,

ve,

cr,

pa

remote

boolean

default:false

within

enum<string>

Jobs Indeed listed or relisted in this window. A relisted job keeps its first publishedAt and shows the new date in indexedAt.

Available options:

day,

week,

month

cursor

string

The cursor from the previous response. Send it as is.

Minimum string length: 1

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

Indeed search API

Example

Authorizations

Body

Response

​Example

Authorizations

Body

Response

Example