> ## 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 search API

> Call the Indeed search API to get title, company, address, location, salary and job types, as JSON or markdown. 1 credit per 20 items, at least 1 credit.

* **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](/advanced-guide#paging).

## Example

<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.search({ query: "data analyst", location: "Chicago, IL", limit: 25 });
  console.log(result.data.jobs);
  ```

  ```python Python icon="python" theme={null}
  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"])
  ```

  ```bash cURL icon="terminal" theme={null}
  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}'
  ```

  ```bash CLI icon="square-terminal" theme={null}
  stophy indeed search --query "data analyst" --location "Chicago, IL" --limit 25
  ```
</CodeGroup>


## OpenAPI

````yaml api-reference/openapi.json POST /v1/indeed/search
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.


    Send Accept: text/markdown to get markdown instead of JSON.


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


    x-credits is what one call costs. When x-per-items is set, a call costs
    x-credits for every x-per-items items it returns, and at least x-credits.


    When a response has a cursor, send it back with the same input to get the
    next page.
servers:
  - url: https://api.stophy.dev
security:
  - apiKey: []
paths:
  /v1/indeed/search:
    post:
      summary: Search Indeed jobs
      description: Costs 1 credit per 20 items. Pages with cursor.
      operationId: indeedSearch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
                  maxLength: 200
                location:
                  type: string
                  minLength: 2
                  maxLength: 200
                radiusKm:
                  default: 40
                  type: number
                  minimum: 0
                  maximum: 160
                country:
                  default: us
                  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
                    - 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
                  description: >-
                    ISO 3166-1 alpha-2 country code, e.g. us. Any case is
                    accepted.
                  type: string
                jobType:
                  type: string
                  enum:
                    - fullTime
                    - partTime
                    - contract
                    - internship
                remote:
                  default: false
                  type: boolean
                within:
                  default: all
                  type: string
                  enum:
                    - day
                    - threeDays
                    - week
                    - twoWeeks
                    - month
                    - all
                salary:
                  type: object
                  properties:
                    min:
                      type: integer
                      exclusiveMinimum: 0
                      maximum: 9007199254740991
                  required:
                    - min
                sort:
                  default: relevance
                  type: string
                  enum:
                    - relevance
                    - newest
                limit:
                  default: 25
                  type: integer
                  minimum: 1
                  maximum: 500
                cursor:
                  type: string
                  pattern: ^\d{1,3}\.\d{1,3}\.[A-Za-z\d+/]*={0,2}$
              additionalProperties: false
            example:
              query: data analyst
              location: Chicago, IL
              limit: 25
      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'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - creditsUsed
                  - requestId
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    additionalProperties: false
                    properties:
                      jobs:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          properties:
                            id:
                              type: string
                            url:
                              type: string
                              format: uri
                            title:
                              type: string
                            company:
                              type: object
                              additionalProperties: false
                              properties:
                                name:
                                  type: string
                                url:
                                  type: string
                                  format: uri
                                avatar:
                                  type: string
                                  format: uri
                                website:
                                  type: string
                                  format: uri
                                industry:
                                  type: string
                                employeesText:
                                  type: string
                                revenueText:
                                  type: string
                                description:
                                  type: string
                              required: []
                            address:
                              type: object
                              additionalProperties: false
                              properties:
                                full:
                                  type: string
                                street:
                                  type: string
                                city:
                                  type: string
                                state:
                                  type: string
                                postalCode:
                                  type: string
                                country:
                                  type: string
                              required: []
                            location:
                              type: object
                              additionalProperties: false
                              properties:
                                lat:
                                  type: number
                                  minimum: -90
                                  maximum: 90
                                lng:
                                  type: number
                                  minimum: -180
                                  maximum: 180
                              required:
                                - lat
                                - lng
                            salary:
                              type: object
                              additionalProperties: false
                              properties:
                                min:
                                  type: number
                                max:
                                  type: number
                                period:
                                  type: string
                                  enum:
                                    - hour
                                    - day
                                    - week
                                    - month
                                    - year
                                currency:
                                  type: string
                                isEstimate:
                                  type: boolean
                              required:
                                - isEstimate
                            jobTypes:
                              type: array
                              items:
                                type: string
                                enum:
                                  - fullTime
                                  - partTime
                                  - contract
                                  - internship
                            isRemote:
                              type: boolean
                            attributes:
                              type: array
                              items:
                                type: string
                            createdAt:
                              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
                          required:
                            - url
                            - isRemote
                            - isEasyApply
                            - isUrgent
                      cursor:
                        type: string
                    required:
                      - jobs
                  creditsUsed:
                    type: integer
                  requestId:
                    type: string
            text/markdown:
              schema:
                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
    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
                - invalidCliSession
                - invalidCliVerifier
                - invalidRequest
                - notFound
                - rateLimited
                - sourceChanged
                - sourceRefused
                - sourceTimeout
                - sourceUnavailable
                - tooManyInFlight
                - unauthorized
                - unsupportedMediaType
            message:
              type: string
            retryable:
              type: boolean
            retryAfterSeconds:
              type: integer
            requestId:
              type: string
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````