List markets
The markets this deployment is configured for.
Each entry carries the currency its rates are quoted in and whether that market's published rates include tax, so a caller can pick a market without hard-coding either fact. Free.
Request
https://api.scrapercompany.com/v1/marketsAuthenticate with your API key in the x-api-key header (see Authentication).
Run this request on your own API key from this page, with the values you type. Signed out? Sign in or get an API key.
Example request
curl "https://api.scrapercompany.com/v1/markets" \
-H "x-api-key: $SCRAPERCOMPANY_API_KEY"Response
200 — Configured markets, each with its verified currency, gl and default tax basis.
{
"markets": [
{
"code": "US",
"currency": "USD",
"label": "United States",
"rates_include_tax": false
},
{
"code": "CA",
"currency": "CAD",
"label": "Canada",
"rates_include_tax": false
}
]
}Response fields
Fields marked required are always present; others appear when they apply.
- marketsarray of objectrequired
Show 4 child fieldsHide child fields
- markets[].codestringrequired
- markets[].currencystringrequired
- markets[].labelstringrequired
- markets[].rates_include_taxbooleanrequired
Default tax basis for the market.
Errors
Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.
| Status | Meaning | Retry? |
|---|---|---|
401Unauthorized | Missing or invalid API key. {"detail":"missing or invalid API key"} | No, fix the request |
429Too Many Requests | Too many requests: the key's requests-per-minute limit was exceeded, or (in {"detail":"rate limit 60/min exceeded"} | Yes, with backoff |
Try it
Press Try it above to run this request on your own key, with the values you type (sign in first). For a no-code walkthrough, use the workspace’s guided Try it.
- Export your key:
export SCRAPERCOMPANY_API_KEY=sk_...(no key yet? start a free trial). - Copy the cURL example above and run it in a terminal.
Questions about this page?
Send the page link and your question, and the team will answer.