List markets

Request#

Authenticate with your API key in the x-api-key header (see Authentication).

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.

Try it#

1. Export your key: export SCRAPERCOMPANY_API_KEY=sk_... (no key yet? request access).
2. Copy the cURL example above and run it in a terminal.
3. Or open the interactive playground on api.scrapercompany.com, paste your key and pick this endpoint.