List markets

GET 
/openapi/2026-01/markets

Retrieve all markets of the store with their configuration.

Request

Query Parameters

only_active boolean

Whether to return only active markets. Defaults to false

with_countries_detail boolean

Whether to include per-country currency detail. Defaults to false

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object
markets object[]
Markets
Array [
idstring
Market ID
namestring
Market name
is_primaryboolean
Whether this is the primary market
is_defaultboolean
Whether this is the default market
market_statusstring
Market status: active or paused
countriesstring[]
Covered countries (ISO 3166-1 alpha-2)
currencystring
Base currency (ISO 4217)
symbol object
Currency symbol detail
valstring
Symbol value (e.g., £)
leftstring
Symbol placed to the left of the amount
rightstring
Symbol placed to the right of the amount
cn_namestring
Chinese name of the currency
titlestring
Currency title
codestring
Currency code (ISO 4217)
local_currency_enabledboolean
Whether local-currency display is enabled
countries_detail object[]
Per-country currency detail. Returned only when with_countries_detail is true in the request
Array [
country_codestring
Country code (ISO 3166-1 alpha-2)
currencystring
Currency code for this country
symbol object
Currency symbol detail
valstring
Symbol value (e.g., £)
leftstring
Symbol placed to the left of the amount
rightstring
Symbol placed to the right of the amount
cn_namestring
Chinese name of the currency
titlestring
Currency title
codestring
Currency code (ISO 4217)
detail object
Country detail
namestring
Country name
cn_namestring
Country Chinese name
continentstring
Continent
flagstring
Flag emoji or identifier
iso_code_2string
ISO 3166-1 alpha-2 code
iso_code_3string
ISO 3166-1 alpha-3 code
]
]

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "markets": [
      {
        "id": "string",
        "name": "string",
        "is_primary": true,
        "is_default": true,
        "market_status": "string",
        "countries": [
          "string"
        ],
        "currency": "string",
        "symbol": {
          "val": "string",
          "left": "string",
          "right": "string",
          "cn_name": "string",
          "title": "string",
          "code": "string"
        },
        "local_currency_enabled": true,
        "countries_detail": [
          {
            "country_code": "string",
            "currency": "string",
            "symbol": {
              "val": "string",
              "left": "string",
              "right": "string",
              "cn_name": "string",
              "title": "string",
              "code": "string"
            },
            "detail": {
              "name": "string",
              "cn_name": "string",
              "continent": "string",
              "flag": "string",
              "iso_code_2": "string",
              "iso_code_3": "string"
            }
          }
        ]
      }
    ]
  }
}