> ## 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.

# Upwork search API

> Search Upwork jobs. Call the Upwork search API and get JSON back in one request. 1 credit per call. Failed calls cost nothing.

Searches Upwork jobs.

## Request

This method has no required parameters.

<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.upwork.search({ query: "react developer" });
  console.log(result.data.results);
  ```

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

  stophy = Stophy()  # reads STOPHY_API_KEY
  result = stophy.upwork.search(query="react developer")
  print(result["data"]["results"])
  ```

  ```bash cURL icon="terminal" theme={null}
  curl -X POST https://api.stophy.dev/v1/upwork/search \
    -H "Authorization: Bearer $STOPHY_API_KEY" \
    -H "content-type: application/json" \
    -d '{"query":"react developer"}'
  ```

  ```bash CLI icon="square-terminal" theme={null}
  stophy upwork search "react developer"
  ```
</CodeGroup>

## Response

If successful, the response body contains the standard envelope. `data.results[]` contains the jobs, each with its budget or hourly rate, skills and posting date.

The following example is illustrative.

```json theme={null}
{
  "success": true,
  "data": {
    "results": [
      {
        "jobId": "~021234567890123456789",
        "jobUrl": "https://www.upwork.com/jobs/~021234567890123456789",
        "title": "React developer for a dashboard",
        "description": "We need a React developer to build a reporting dashboard.",
        "skills": ["React", "TypeScript"],
        "type": "hourly",
        "experienceLevel": "intermediate",
        "workload": "partTime",
        "duration": "oneToThreeMonths",
        "hourlyRateMin": 30,
        "hourlyRateMax": 60,
        "publishedAt": "2026-10-05T09:30:00.000Z"
      }
    ],
    "total": 1250,
    "page": 1
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}
```

| Field | Type | Description |
| - | - | - |
| `type` | string | Indicates whether the job pays by the hour (`hourly`) or a fixed price (`fixed`). |
| `workload` | string | Upwork's hours needed. Empty when the job does not say, including fixed-price jobs and clients who are not sure. |
| `duration` | string | Upwork's project length. `underOneMonth` is under one month, `oneToThreeMonths` is one to three months, `threeToSixMonths` is three to six months, and `overSixMonths` is longer. |
| `page` | integer | The page number of this response. |
| `total` | integer | The total number of matching results, across all pages. |
| `publishedAt` | string (ISO 8601) | The publication time, in UTC. |

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

<Note>`workload`, `duration` and the hourly rate filters apply to hourly jobs only.</Note>

## Optional parameters

| Parameter | Type | Description |
| - | - | - |
| `query` | string | Words to search for. |
| `sort` | string | Specifies the order of the jobs. Acceptable values are `newest` and `relevance`. If unset, defaults to `newest`. |
| `jobType` | string | Hourly jobs or fixed-price jobs. Acceptable values are `hourly` and `fixed`. |
| `experienceLevel` | string | Restricts results to jobs that ask for this level. Acceptable values are `entry`, `intermediate` and `expert`. |
| `workload` | string | Hours needed: full time, part time or as needed. Only hourly jobs say this, so the search stays hourly. Acceptable values are `fullTime`, `partTime` and `asNeeded`. |
| `duration` | string | Project length: under one month, one to three months, three to six months or over six months. Only hourly jobs say this, so the search stays hourly. Acceptable values are `underOneMonth`, `oneToThreeMonths`, `threeToSixMonths` and `overSixMonths`. |
| `minHourlyRate` | integer | The minimum hourly rate in USD. A job matches when its posted range overlaps this minimum, so 25 to 50 matches a minimum of 50. The search stays hourly. Must be between 1 and 999. |
| `maxHourlyRate` | integer | The maximum hourly rate in USD. Requires `minHourlyRate`. The job's posted range overlaps both, and the search stays hourly. Must be between 1 and 999. |
| `page` | integer | The page to return. Pages are numbered from 1. Must be between 1 and 100. If unset, defaults to `1`. |

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

Results are paginated. To retrieve the next page, increment `page`. An empty `data.results` indicates the last page. The maximum value of `page` is 100.

## Related methods

* [Upwork job](/api-reference/endpoint/upwork-job): Accepts `jobUrl`. Returns an Upwork job's details.


## OpenAPI

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


    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/upwork/search:
    post:
      summary: Search Upwork jobs
      description: Costs 1 credit per call. Pages with page.
      operationId: upworkSearch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
                  minLength: 1
                  maxLength: 200
                sort:
                  default: newest
                  type: string
                  enum:
                    - newest
                    - relevance
                jobType:
                  type: string
                  enum:
                    - hourly
                    - fixed
                experienceLevel:
                  type: string
                  enum:
                    - entry
                    - intermediate
                    - expert
                workload:
                  description: >-
                    Upwork's hours needed: full time, part time, or as needed.
                    Only hourly jobs say this, so the search stays hourly.
                  type: string
                  enum:
                    - fullTime
                    - partTime
                    - asNeeded
                duration:
                  description: >-
                    Upwork's project length: under one month, one to three
                    months, three to six months, or more than six months. Only
                    hourly jobs say this, so the search stays hourly.
                  type: string
                  enum:
                    - underOneMonth
                    - oneToThreeMonths
                    - threeToSixMonths
                    - overSixMonths
                minHourlyRate:
                  description: >-
                    Lowest hourly rate in USD. A job matches when its posted
                    range overlaps this minimum, so 25 to 50 matches a minimum
                    of 50. The search stays hourly.
                  type: integer
                  minimum: 1
                  maximum: 999
                maxHourlyRate:
                  description: >-
                    Highest hourly rate in USD. Send it with minHourlyRate. The
                    job's posted range overlaps both, and the search stays
                    hourly.
                  type: integer
                  minimum: 1
                  maximum: 999
                page:
                  default: 1
                  description: Page number, starting at 1.
                  type: integer
                  minimum: 1
                  maximum: 100
              additionalProperties: false
            example:
              query: react developer
      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:
                      total:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      results:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          properties:
                            jobId:
                              type: string
                            jobUrl:
                              type: string
                              format: uri
                            title:
                              type: string
                            description:
                              type: string
                            skills:
                              type: array
                              items:
                                type: string
                            type:
                              type: string
                              enum:
                                - hourly
                                - fixed
                            experienceLevel:
                              type: string
                              enum:
                                - entry
                                - intermediate
                                - expert
                            workload:
                              description: >-
                                Upwork's hours needed. Empty when the job does
                                not say, including fixed-price jobs and clients
                                who are not sure.
                              type: string
                              enum:
                                - fullTime
                                - partTime
                                - asNeeded
                            duration:
                              description: >-
                                Upwork's project length. underOneMonth is under
                                one month, oneToThreeMonths is one to three
                                months, threeToSixMonths is three to six months,
                                and overSixMonths is longer.
                              type: string
                              enum:
                                - underOneMonth
                                - oneToThreeMonths
                                - threeToSixMonths
                                - overSixMonths
                            hourlyRateMin:
                              type: number
                            hourlyRateMax:
                              type: number
                            fixedBudget:
                              type: number
                            budgetCurrency:
                              type: string
                            durationWeeks:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            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))$
                          required:
                            - jobUrl
                      page:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                    required:
                      - results
                      - page
                  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.