Skip to main content

REST API Settings - Get market

Get market

Written by Albert
Updated over 2 weeks ago

Get market

GET /frontoffice/api/v5/markets/{marketId}

Summary

Use this method to retrieve detailed information about a specific market using its market identifier.

Request

Path parameters

marketId required

The market identifier, in the following format: {marketType}.{baseAssetId}_{quoteAssetId}, for example: cfd.eth_eur.

Request example

GET /frontoffice/api/v5/markets/{marketId} HTTP/1.1
Host: {host}
Authorization: Bearer JWT
Accept: */*

Response

In case of success, an object will be returned.

Each object contains the following information:

marketId string

The market identifier, in the following format: {marketType}.{baseAssetId}_{quoteAssetId}, for example: cfd.eth_eur.

displayName string

The market ticker.

fullName string | nullable

The market full name or description (optional).

baseAssetId string

The base asset identifier.

quoteAssetId string

The quote asset identifier.

minAmount decimal string | nullable

Applicable to Spot markets only.

The minimum tradable amount of the base asset.

maxBaseAmount decimal string | nullable

The maximum tradable amount of the base asset.

priceDeviation decimal string

The allowed price deviation for Limit orders placed on the market.

Supports decimal values in the range [0, 1], with up to 4 decimal places, for example:

  • 0.1 = 10%

  • 0.01 = 1%

  • 0.001 = 0.1%

  • 0.0001 = 0.01%

If set to 0, no restriction is applied, the price deviation is ignored.

priceScale integer

The price precision, which is the number of digits after a decimal separator. Also determines the minimum allowed trade price.

Supports only integer values in the range [2, 8]. For example, 2 means the following price format: 0.01, and 8: 0.00000001.

amountScale integer | nullable

Applicable to Spot markets only.

The amount precision, which is the number of digits after a decimal separator. Also determines the minimum trade amount.

Supports only integer values in the range [0, 8]. For example:

  • 0 means 1 (no digits after the decimal separator)

  • 5 means 0.00001 (five digits after the decimal separator)

  • 8 means 0.00000001 (eight digits after the decimal separator)

type string

The market type.

Possible values:

  • Spot

  • Cfd

  • Perp

subtype string | nullable

Applicable to CFD markets only.

The market subtype.

Possible values:

  • Crypto

  • Fx

  • Metals

  • Indices

  • Energies

  • Ndf

  • Shares

  • Etf

swapSettings object | nullable

Applicable to CFD markets only.

The fee type charged for holding open positions overnight. The amount can be negative for rebates.

Possible values:

  • FixPerLot: The fixed amount per lot.

  • Percent: The fixed amount in points which is applied to the position size, in the range [-1, 1], with up to 5 decimal places.

  • Points: The fixed amount of percents which is applied to the position size, with up to 3 decimal places.

Structure:

  • type string — Swap calculation type. Possible values: FixPerLot, Percent, Points.

  • shortPositionSettings object — Settings for Short positions:

    • size decimal string

    • assetId string | nullable

  • longPositionSettings object — Settings for Long positions:

    • size decimal string

    • assetId string | nullable

lotSize integer | nullable

Not applicable to Spot markets.

The standardized quantity of the base asset per lot.

Supports only integer values in the range [1, 1000000].

minLotAmount decimal string | nullable

Not applicable to Spot markets.

The minimum order amount, in lots, that can be placed and executed.

Supports values in the range [0.00000001, 1].

maxLotAmount integer | nullable

Not applicable to Spot markets.

The maximum order amount, in lots, that can be placed and executed.

Supports only integer values in the range [1, 10000].

tickSize decimal string | nullable

Not applicable to Spot markets.

The minimum price increment.

lotStep decimal string | nullable

Not applicable to Spot markets.

The minimum lot amount increment.

Supports values in the range [0.00000001, 1]. By default, equals to the minLotAmount.

slippageRate decimal string

The expected slippage, that is, the difference between the expected execution price and the actual one. This value is used as a multiplier to calculate the funds to be put on hold for a market order execution.

Supports values in the range [1, 10], including decimal values with up to 4 decimal places. The default value is 1 which means that only the current bid/ask price is put on hold. For example, 1.1 means that the current bid or ask price + 10% is put on hold for each order, to cover the 10% slippage.

Mind that the total amount funds to be held depends on the order parameters and takes into account many conditions, the slippage rate is only one of them.

calendar object

The trading calendar defining market trading hours.

Structure:

  • timeZoneId string — IANA time zone identifier.

  • tradingSessions array — Weekly trading sessions:

    • dayOfWeek string — One of: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.

    • timeIntervals array — List of intervals with:

      • start string (time) — Start time in calendar.timeZoneId.

      • end string (time) — End time in calendar.timeZoneId.

  • sessionOverrides array — Optional specific-date overrides:

    • date string (date) — In YYYY-MM-DD format.

    • timeIntervals array | nullable — Intervals for that date.

fundingStartTime string | nullable

Applicable to Perpetual markets only.

The time of the first funding settlement, in the following format: HH:MM:SS.

fundingIntervalInHours integer | nullable

Applicable to Perpetual markets only.

The funding settlement interval, in hours.

Possible values: 1, 2, 3, 4, 6, 8, 12, 24.

leverageProfile object

Not applicable to Spot markets.

The leverage profile.

Structure:

  • leverageType string — Leverage type. Possible values: Fixed, Dynamic.

  • leverage object

    • useOnlyMaxLeverage boolean

    • maxLeverage integer — For Fixed leverage type only.

    • tiers array — For Dynamic leverage type only.

      • maxLeverage integer — The maximum allowed leverage for this tier.

      • maxNotionalValueInRAT string | nullable — The maximum position notional for this tier.

commissionSettings object

The commission settings.

Structure:

  • type string — Leverage type. Possible values: Fixed, Dynamic.

  • charge object

    • type string — Possible values: Percent, FixPerLot.

    • assetId string | nullable — For Fixed commission type only.

    • size decimal string — For Fixed commission type only.

    • tiers array — For Dynamic commission type only.

      • size string — The commission amount for this tier.

      • minTradingVolumeInRAT string — The minimum required trading volume for this tier.

    • minCommissionInRAT decimal string | nullable

  • dynamicCommissionGroupId

Response example — 200: OK

{
  "marketId": "string",
  "displayName": "string",
  "fullName": "string",
  "baseAssetId": "string",
  "quoteAssetId": "string",
  "minAmount": "string",
  "maxBaseAmount": "string",
  "minQuoteAmount": "string",
  "priceDeviation": "string",
  "priceScale": 0,
  "amountScale": 0,
  "type": "Spot",
  "subtype": "Cash",
  "swapSettings": {
    "type": "FixPerLot",
    "shortPositionSettings": {
      "size": "string",
      "assetId": "string"
    },
    "longPositionSettings": {
      "size": "string",
      "assetId": "string"
    }
  },
  "lotSize": 0,
  "minLotAmount": "string",
  "maxLotAmount": 0,
  "tickSize": "string",
  "lotStep": "string",
  "slippageRate": "string",
  "calendar": {
    "timeZoneId": "string",
    "tradingSessions": [
      {
        "dayOfWeek": "Monday",
        "timeIntervals": [
          {
            "start": "string",
            "end": "string"
          }
        ]
      }
    ],
    "sessionOverrides": [
      {
        "date": "2025-12-18",
        "timeIntervals": [
          {
            "start": "string",
            "end": "string"
          }
        ]
      }
    ]
  },
  "fundingStartTime": "string",
  "fundingIntervalInHours": 0,
  "leverageProfile": {
    "leverageType": "Fixed",
    "leverage": {
      "useOnlyMaxLeverage": true,
      "maxLeverage": 0
    }
  },
  "commissionSettings": {
    "type": "Dynamic",
    "сharge": {
      "type": "Percent",
      "tiers": [
        {
          "size": "string",
          "minTradingVolumeInRAT": "string"
        },
        {
          "size": "string",
          "minTradingVolumeInRAT": "string"
        }
      ],
      "minCommissionInRAT": "string"
    },
    "dynamicCommissionGroupId": "string"
  }
}

Did this answer your question?