> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Indeed job API

> Get an Indeed job's details. Call the Indeed job API and get JSON back in one request. 1 credit per call. Failed calls cost nothing.

Returns an Indeed job's details. The job is identified by its URL or ID.

## Request

Exactly one of `jobUrl` or `jobId` is required. A request that sets both, or none, fails with `invalidRequest`.

<CodeGroup>
  ```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null}
  import { Stophy } from "stophy";

  const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
  const result = await stophy.indeed.job({ jobId: "a1b2c3d4e5f60718" });
  console.log(result.data);
  ```

  ```python Python icon="python" theme={null}
  from stophy import Stophy

  stophy = Stophy()  # reads STOPHY_API_KEY
  result = stophy.indeed.job(job_id="a1b2c3d4e5f60718")
  print(result["data"])
  ```

  ```bash cURL icon="terminal" theme={null}
  curl -X POST https://api.stophy.dev/v1/indeed/job \
    -H "Authorization: Bearer $STOPHY_API_KEY" \
    -H "content-type: application/json" \
    -d '{"jobId":"a1b2c3d4e5f60718"}'
  ```

  ```bash CLI icon="square-terminal" theme={null}
  stophy indeed job --jobId a1b2c3d4e5f60718
  ```
</CodeGroup>

## Response

If successful, the response body contains the standard envelope. `data` contains the job's company, pay, location and full description.

The following example is a real response, truncated: each list shows one item and long strings are cut.

```json theme={null}
{
  "success": true,
  "data": {
    "jobId": "57f5b67299fda823",
    "jobUrl": "https://www.indeed.com/viewjob?jk=57f5b67299fda823",
    "title": "Sr. Data Analyst, Customer Analytics (Insurance)",
    "companyName": "CCC Intelligent Solutions",
    "companyUrl": "https://www.indeed.com/cmp/Ccc-Intelligent-Solutions-1",
    "companyAvatarUrl": "https://d2q79iu7y748jz.cloudfront.net/s/_squarelogo/256x256/9b657fd43e3a37b384dcc01be5a555d7",
    "companyWebsite": "http://www.cccis.com",
    "companyEmployeesText": "1,001 to 5,000",
    "companyRevenueText": "Decline to state",
    "companyDescription": "At CCC, we’re all about connectedness - from our people to our products. Our team is truly reshaping the auto and…",
    "addressFull": "Chicago, IL 60607",
    "addressCity": "Chicago",
    "addressRegion": "IL",
    "addressPostalCode": "60607",
    "addressCountry": "US",
    "latitude": 41.885124,
    "longitude": -87.64813,
    "salaryMin": 84724,
    "salaryMax": 120000,
    "salaryPeriod": "year",
    "salaryCurrency": "USD",
    "salaryIsEstimate": false,
    "jobTypes": ["fullTime"],
    "isRemote": false,
    "isHybrid": false,
    "experienceLevels": ["senior"],
    "educationLevels": ["bachelor"],
    "attributes": ["AI models"],
    "publishedAt": "2026-10-05T05:00:00.000Z",
    "indexedAt": "2026-10-05T16:08:42.293Z",
    "applyUrl": "https://cccis.wd1.myworkdayjobs.com/broadbean_external/job/Chicago-Green-St-IL/Sr-Data-Analyst--Customer-Analytics--Ins…",
    "isEasyApply": true,
    "isUrgent": false,
    "source": "CCC Information Services Inc.",
    "description": "CCC Intelligent Solutions Inc. (CCC) is a leading cloud platform for the multi-trillion-dollar insurance economy,…",
    "descriptionHtml": "<div><p>CCC Intelligent Solutions Inc. (CCC) is a leading cloud platform for the multi-trillion-dollar insurance…",
    "isExpired": false,
    "language": "en"
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}
```

| Field | Type | Description |
| - | - | - |
| `publishedAt` | string (ISO 8601) | The publication time, in UTC. |

For every field, see the response schema on this page.

## Optional parameters

| Parameter | Type | Description |
| - | - | - |
| `country` | string | The country to query, as a two-letter ISO 3166-1 code such as `us`. Accepts one of 62 values, such as `us`, `gb` and `ca`. |

## Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

## Pagination

This method is not paginated. A single request returns the complete result.

## Related methods

* [Indeed search](/api-reference/endpoint/indeed-search): Accepts the job's `title` as `query`. Searches Indeed jobs.


## OpenAPI

````yaml api-reference/openapi.json POST /v1/indeed/job
openapi: 3.1.0
info:
  title: Stophy API
  version: '1'
  description: >-
    Every endpoint is a POST that takes its input as a JSON object body. Unknown
    fields are rejected with 400.


    Responses leave out empty values: null, empty strings, empty objects and
    empty nested lists are not sent.


    x-credits is what one call costs. Every call costs the same, whatever it
    returns, unless an operation's description says it costs per 10 results, or
    per second of audio. Then x-credits is the lowest price and x-credits-max
    the most one call can cost. Where an operation takes limit, send it to
    return fewer results and pay for fewer.


    When a response has a cursor, send it back unchanged with the same input to
    get the next page. When it has a page, send the next page number.
servers:
  - url: https://api.stophy.dev
security:
  - apiKey: []
paths:
  /v1/indeed/job:
    post:
      summary: Get an Indeed job's details
      description: Costs 1 credit per call.
      operationId: indeedJob
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                jobUrl:
                  type: string
                  description: >-
                    Link to the Indeed job, like
                    https://www.indeed.com/viewjob?jk=a1b2c3d4e5f60718. Send
                    this or jobId.
                jobId:
                  type: string
                  description: Indeed job id, like a1b2c3d4e5f60718. Send this or jobUrl.
                country:
                  enum:
                    - 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
                  description: >-
                    ISO 3166-1 alpha-2 country code, e.g. us. Any case is
                    accepted.
                  type: string
              sendOne:
                - jobUrl
                - jobId
              additionalProperties: false
      responses:
        '200':
          description: The data, and the credits this call used.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestId'
            x-credits-used:
              $ref: '#/components/headers/CreditsUsed'
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            x-cache:
              $ref: '#/components/headers/Cache'
            x-cache-age:
              $ref: '#/components/headers/CacheAge'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - creditsUsed
                  - requestId
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    additionalProperties: false
                    properties:
                      jobId:
                        type: string
                      jobUrl:
                        type: string
                        format: uri
                      title:
                        type: string
                      companyName:
                        type: string
                      companyUrl:
                        type: string
                        format: uri
                      companyAvatarUrl:
                        type: string
                        format: uri
                      companyWebsite:
                        type: string
                        format: uri
                      companyIndustry:
                        type: string
                      companyEmployeesText:
                        type: string
                      companyRevenueText:
                        type: string
                      companyDescription:
                        type: string
                      addressFull:
                        type: string
                      addressCity:
                        type: string
                      addressRegion:
                        type: string
                      addressPostalCode:
                        type: string
                      addressCountry:
                        type: string
                      latitude:
                        type: number
                        minimum: -90
                        maximum: 90
                      longitude:
                        type: number
                        minimum: -180
                        maximum: 180
                      salaryMin:
                        type: number
                      salaryMax:
                        type: number
                      salaryPeriod:
                        type: string
                        enum:
                          - hour
                          - day
                          - week
                          - month
                          - year
                      salaryCurrency:
                        type: string
                      salaryIsEstimate:
                        type: boolean
                      jobTypes:
                        type: array
                        items:
                          type: string
                          enum:
                            - fullTime
                            - partTime
                            - contract
                            - temporary
                            - internship
                      isRemote:
                        type: boolean
                      isHybrid:
                        type: boolean
                      experienceLevels:
                        type: array
                        items:
                          type: string
                          enum:
                            - noExperience
                            - entry
                            - mid
                            - senior
                      educationLevels:
                        type: array
                        items:
                          type: string
                          enum:
                            - highSchool
                            - associate
                            - bachelor
                            - master
                      attributes:
                        type: array
                        items:
                          type: string
                      publishedAt:
                        type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                      indexedAt:
                        type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                      applyUrl:
                        type: string
                        format: uri
                      isEasyApply:
                        type: boolean
                      isUrgent:
                        type: boolean
                      source:
                        type: string
                      description:
                        type: string
                      descriptionHtml:
                        type: string
                      isExpired:
                        type: boolean
                      language:
                        type: string
                    required:
                      - jobUrl
                      - salaryIsEstimate
                      - jobTypes
                      - isRemote
                      - isHybrid
                      - experienceLevels
                      - educationLevels
                      - attributes
                      - isEasyApply
                      - isUrgent
                      - isExpired
                  creditsUsed:
                    type: integer
                  requestId:
                    type: string
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
components:
  headers:
    RequestId:
      description: The request id. Quote it when you report a problem.
      schema:
        type: string
    CreditsUsed:
      description: Credits this call used.
      schema:
        type: integer
    RateLimitLimit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window.
      schema:
        type: integer
    RateLimitReset:
      description: Unix time in seconds when the current window resets.
      schema:
        type: integer
    Cache:
      description: hit if this result came from the cache, miss if it was fetched live.
      schema:
        type: string
    CacheAge:
      description: Seconds since the returned result was written to the cache.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  responses:
    Error:
      description: The request failed. retryable says whether trying again can help.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - success
        - error
      properties:
        success:
          const: false
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - requestId
          properties:
            code:
              type: string
              enum:
                - cliSessionCompleted
                - cliSessionExists
                - cliSessionNotFound
                - forbidden
                - insufficientCredits
                - internalError
                - inviteClaimed
                - inviteDisabled
                - inviteExpired
                - inviteUsedUp
                - invalidCliSession
                - invalidCliVerifier
                - invalidRequest
                - notFound
                - rateLimited
                - sourceChanged
                - sourceRefused
                - sourceTimeout
                - sourceUnavailable
                - tooManyInFlight
                - unauthorized
                - unsupportedMediaType
            message:
              type: string
            retryable:
              type: boolean
            retryAfterSeconds:
              type: integer
            requestId:
              type: string
            requiredCredits:
              type: number
            availableCredits:
              type: number
            billingUrl:
              type: string
              const: https://stophy.dev/billing
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.