Upwork search API

Search Upwork jobs

curl --request POST \
  --url https://api.stophy.dev/v1/upwork/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "react developer"
}
'

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

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

import requests

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

payload = { "query": "react developer" }
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>",
        "jobId": "<string>",
        "title": "<string>",
        "description": "<string>",
        "skills": [
          "<string>"
        ],
        "type": "hourly",
        "experienceLevel": "entry",
        "workload": "fullTime",
        "duration": "underOneMonth",
        "hourlyRateMin": 123,
        "hourlyRateMax": 123,
        "fixedBudget": 123,
        "budgetCurrency": "<string>",
        "durationWeeks": 0,
        "publishedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "page": 0,
    "total": 0
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

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

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

POST

upwork

Search Upwork jobs

curl --request POST \
  --url https://api.stophy.dev/v1/upwork/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "react developer"
}
'

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

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

import requests

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

payload = { "query": "react developer" }
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>",
        "jobId": "<string>",
        "title": "<string>",
        "description": "<string>",
        "skills": [
          "<string>"
        ],
        "type": "hourly",
        "experienceLevel": "entry",
        "workload": "fullTime",
        "duration": "underOneMonth",
        "hourlyRateMin": 123,
        "hourlyRateMax": 123,
        "fixedBudget": 123,
        "budgetCurrency": "<string>",
        "durationWeeks": 0,
        "publishedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "page": 0,
    "total": 0
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

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

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

Searches Upwork jobs.

Request

This method has no required parameters.

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);

from stophy import Stophy

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

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"}'

stophy upwork search "react developer"

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.

{
  "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.

workload, duration and the hourly rate filters apply to hourly jobs only.

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.

Upwork job: Accepts jobUrl. Returns an Upwork job’s details.

Authorizations

Authorization

string

header

required

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

Body

application/json

query

string

Required string length: 1 - 200

sort

enum<string>

default:newest

Available options:

newest,

relevance

jobType

enum<string>

Available options:

hourly,

fixed

experienceLevel

enum<string>

Available options:

entry,

intermediate,

expert

workload

enum<string>

Upwork's hours needed: full time, part time, or as needed. Only hourly jobs say this, so the search stays hourly.

Available options:

fullTime,

partTime,

asNeeded

duration

enum<string>

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.

Available options:

underOneMonth,

oneToThreeMonths,

threeToSixMonths,

overSixMonths

minHourlyRate

integer

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.

Required range: 1 <= x <= 999

maxHourlyRate

integer

Highest hourly rate in USD. Send it with minHourlyRate. The job's posted range overlaps both, and the search stays hourly.

Required range: 1 <= x <= 999

page

integer

default:1

Page number, starting at 1.

Required range: 1 <= x <= 100

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

Upwork search API

Request

Response

Optional parameters

Billing

Authorizations

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods