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",
  "limit": 25
}
'

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

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",
    "limit": 25
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "jobs": [
      {
        "url": "<string>",
        "isRemote": true,
        "isEasyApply": true,
        "isUrgent": true,
        "id": "<string>",
        "title": "<string>",
        "company": {
          "name": "<string>",
          "url": "<string>",
          "avatar": "<string>",
          "website": "<string>",
          "industry": "<string>",
          "employeesText": "<string>",
          "revenueText": "<string>",
          "description": "<string>"
        },
        "address": {
          "full": "<string>",
          "street": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postalCode": "<string>",
          "country": "<string>"
        },
        "location": {
          "lat": 0,
          "lng": 0
        },
        "salary": {
          "isEstimate": true,
          "min": 123,
          "max": 123,
          "period": "hour",
          "currency": "<string>"
        },
        "jobTypes": [
          "fullTime"
        ],
        "attributes": [
          "<string>"
        ],
        "createdAt": "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": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123
  }
}

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",
  "limit": 25
}
'

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

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",
    "limit": 25
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "jobs": [
      {
        "url": "<string>",
        "isRemote": true,
        "isEasyApply": true,
        "isUrgent": true,
        "id": "<string>",
        "title": "<string>",
        "company": {
          "name": "<string>",
          "url": "<string>",
          "avatar": "<string>",
          "website": "<string>",
          "industry": "<string>",
          "employeesText": "<string>",
          "revenueText": "<string>",
          "description": "<string>"
        },
        "address": {
          "full": "<string>",
          "street": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postalCode": "<string>",
          "country": "<string>"
        },
        "location": {
          "lat": 0,
          "lng": 0
        },
        "salary": {
          "isEstimate": true,
          "min": 123,
          "max": 123,
          "period": "hour",
          "currency": "<string>"
        },
        "jobTypes": [
          "fullTime"
        ],
        "attributes": [
          "<string>"
        ],
        "createdAt": "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": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123
  }
}

Endpoint: indeed.search
Returns: data has jobs.
Cost: 1 credit per 20 items, at least 1 credit. Failed calls cost nothing.
Paging: Yes. Send the cursor from the response to get the next page. See Paging.

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", limit: 25 });
console.log(result.data.jobs);

from stophy import Stophy

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

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","limit":25}'

stophy indeed search --query "data analyst" --location "Chicago, IL" --limit 25

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

Required string length: 2 - 200

radiusKm

number

default:40

Required range: 0 <= x <= 160

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,

mt,

cy,

pl,

cz,

sk,

hu,

ro,

bg,

hr,

si,

ee,

lv,

lt,

fi,

se,

no,

dk,

ua,

tr,

il,

eg,

ma,

mx,

br,

ar,

cl,

co,

pe,

ec,

uy,

ve,

cr,

pa

jobType

enum<string>

Available options:

fullTime,

partTime,

contract,

internship

remote

boolean

default:false

within

enum<string>

default:all

Available options:

day,

threeDays,

week,

twoWeeks,

month,

all

salary

object

Show child attributes

sort

enum<string>

default:relevance

Available options:

relevance,

newest

limit

integer

default:25

Required range: 1 <= x <= 500

cursor

string

Pattern: ^\d{1,3}\.\d{1,3}\.[A-Za-z\d+/]*={0,2}$

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

Web search and pages

Video

Social

Places and travel

Shopping

Apps

Jobs

Real estate

Ads

Finance and crypto

Indeed search API

Example

Authorizations

Body

Response

​Example

Authorizations

Body

Response

Example