stophy-dev Upwork API
The Upwork API from stophy-dev — 2 operation(s) for upwork.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/stophy-dev:stophy-dev-upwork-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Stophy Upwork 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.
Text comes back whole. To get shorter responses, add ?maxTextLength= to the URL. Every text value longer than that is cut and ends with …. A screenshot is never cut, and a page whose text was cut has isTruncated set to true.
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.
Endpoints whose security includes {} also work without an API key: 10 requests a minute and 50 a day per IP, and no paging.'
servers:
- url: https://api.stophy.dev
security:
- apiKey: []
tags:
- name: Upwork
paths:
/v1/upwork/search:
post:
operationId: upworkSearch
summary: Scrape Upwork job search results
description: Costs 1 credit per call. Pages with page.
x-credits: 1
parameters:
- $ref: '#/components/parameters/MaxTextLength'
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'
tags:
- Upwork
/v1/upwork/job:
post:
operationId: upworkJob
summary: Scrape an Upwork job page
description: Costs 1 credit per call.
x-credits: 1
parameters:
- $ref: '#/components/parameters/MaxTextLength'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
jobUrl:
type: string
description: Link to the Upwork job, like https://www.upwork.com/jobs/~021234567890123456789. Send this or jobId.
jobId:
type: string
description: Upwork job id, like ~021234567890123456789. Send this or jobUrl.
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
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))$
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))$
status:
type: string
category:
type: string
categoryGroup:
type: string
durationText:
type: string
applicants:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
hired:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
interviewing:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
invitesSent:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
unansweredInvites:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
positions:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
lastClientActivityAt:
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))$
clientCity:
type: string
clientCountry:
type: string
clientTimezone:
type: string
clientTotalSpent:
type: number
clientHires:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
clientJobsWithHires:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
clientActiveContracts:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
clientReviews:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
clientRating:
type: number
clientOpenJobs:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
clientPostedJobs:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
clientJoinedAt:
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))$
clientIndustry:
type: string
clientCompanySize:
type: string
required:
- jobUrl
- skills
creditsUsed:
type: integer
requestId:
type: string
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Upwork
components:
headers:
RateLimitLimit:
description: Requests allowed in the current window.
schema:
type: integer
Cache:
description: hit if this result came from the cache, miss if it was fetched live.
schema:
type: string
RateLimitRemaining:
description: Requests left in the current window.
schema:
type: integer
CreditsUsed:
description: Credits this call used.
schema:
type: integer
CacheAge:
description: Seconds since the returned result was written to the cache.
schema:
type: integer
RateLimitReset:
description: Unix time in seconds when the current window resets.
schema:
type: integer
RequestId:
description: The request id. Quote it when you report a problem.
schema:
type: string
RetryAfter:
description: Seconds to wait before retrying.
schema:
type: integer
parameters:
MaxTextLength:
name: maxTextLength
in: query
required: false
description: Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.
schema:
type: integer
minimum: 1
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
- 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
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'
securitySchemes:
apiKey:
type: http
scheme: bearer