Home Admin guide Platform API Methods for managing tiers

Methods for managing tiers

Markets can be grouped under tiers which determine the maker and taker fees charged for trading specific volumes. Each market can only be listed by a single tier group, while each tier group can encompass any number of markets.

With tier groups, you can define a series of volume levels at which special fees apply. By acting upon the group metrics at hand, you can encourage trading on your exchange.

Use these methods to view and manage tiers and tier groups:

GET[host]/back-api/backoffice/tiers	Get tier group settings
GET[host]/back-api/backoffice/tiers/tier	Get tier settings
POST[host]/back-api/backoffice/tiers/tier	Add a tier
PUT[host]/back-api/backoffice/tiers/tier/{tier_id}	Update tier settings
DELETE[host]/back-api/backoffice/tiers/tier/{tier_id}	Remove a tier
GET[host]/back-api/backoffice/tiers/group	Get a tier group list
POST[host]/back-api/backoffice/tiers/groups	Create a tier group
PUT[host]/back-api/backoffice/tiers/group/{group_id}	Update the tier group title
DELETE[host]/back-api/backoffice/tiers/group/{group_id}	Remove a tier group
GET[host]/back-api/backoffice/tiers/market	Get a list of tier markets
POST[host]/back-api/backoffice/tiers/market	Add a market to a tier group
DELETE[host]/back-api/backoffice/tiers/market/{market_id}	Remove a market from a tier group

Get tier group settings

Use this method to view the current configuration of each tier group, along with its tiers and market preferences.

Request

Header parameters:

Authorization: Bearer <access_token>

GET[host]/back-api/backoffice/tiers

GET /back-api/backoffice/tiers HTTP/1.1
Host: host.name
Authorization: Bearer akvmn34egjidg0jifgjdg0djg34g

Response

rootAsset string

The root asset set for the exchange.

groups array

For each tier group in the array, the linked tiers and markets are listed:

tiers array

The following settings are listed for each tier:

id number: The tier identifier.
description string: The tier description.
volume number: The minimum asset volume that must be traded for special taker and maker fees to apply.
makerFee number: The maker fee. This value is normalized to 0–1 range (where 0.15 assumes the fee of 15%).
takerFee number: The taker fee. This value is normalized to 0–1 range (where 0.15 assumes the fee of 15%).
tierGroupId number: The tier group to which this tier belongs.

markets array

The following settings are listed for each market:

marketId string: The market identifier (such as btc_usdt): {baseAsset}_{quoteAsset}.
tierGroupId number: The tier group that includes this market.

id

The tier group identifier.

description string

The tier group title.

    RESPONSE EXAMPLE
  
{
  "rootAsset": "usd",
  "groups": [
    {
      "tiers": [
        {
          "id": 1,
          "description": "Vip 0",
          "volume": 0.0,
          "makerFee": 0.0012,
          "takerFee": 0.0015,
          "tierGroupId": 1
        },
        {
          "id": 2,
          "description": "Vip 0",
          "volume": 1.0,
          "makerFee": 0.0012,
          "takerFee": 0.0015,
          "tierGroupId": 1
        }
      ],
      "markets": [
        {
          "marketId": "btc_usd",
          "tierGroupId": 1
        },
        {
          "marketId": "btc_usdt",
          "tierGroupId": 1
        }
      ],
      "id": 1,
      "description": "group1 description"
    }
  ]
}

Get tier settings

Use this method to view the current configuration of each tier.

Request

Header parameters:

Authorization: Bearer <access_token>

GET[host]/back-api/backoffice/tiers/tier

GET /back-api/backoffice/tiers/tier HTTP/1.1
Host: host.name
Authorization: Bearer akvmn34egjidg0jifgjdg0djg34g

Response

id number: The tier identifier.
description string: The tier title.
volume number: The minimum asset volume that must be traded for special taker and maker fees to apply.
makerFee number: The maker fee. This value is normalized to 0–1 range (where 0.15 assumes the fee of 15%).
takerFee number: The taker fee. This value is normalized to 0–1 range (where 0.15 assumes the fee of 15%).
tier_group_id number: The tier group to which this tier belongs.

    RESPONSE EXAMPLE
  
[
  {
    "id": 2,
    "description": "first tier",
    "volume": 0.000001,
    "maker_fee": 0.2,
    "taker_fee": 0.2,
    "tier_group_id": 1
  }
]

Add a tier

Use this method to introduce a new tier on the exchange.

Request

Header parameters:

Authorization: Bearer <access_token>

Body:

description string: The tier title.
volume number: The minimum asset volume that must be traded for special taker and maker fees to apply.
makerFee number: The maker fee. This value is normalized to 0–1 range (where 0.15 assumes the fee of 15%).
takerFee number: The taker fee. This value is normalized to 0–1 range (where 0.15 assumes the fee of 15%).
tier_group_id string: The tier group to which this tier belongs.

POST[host]/back-api/backoffice/tiers/tier

POST /back-api/backoffice/tiers/tier HTTP/1.1
Host: host.name
Authorization: Bearer akvmn34egjidg0jifgjdg0djg34g

{
  "description": "fourth tier",
  "volume": 100000000,
  "maker_fee": 0.006,
  "taker_fee": 0.006,
  "tier_group_id": 1
}

Response

id number: The tier identifier.
description string: The tier title.
volume number: The minimum asset volume that must be traded for special taker and maker fees to apply.
makerFee number: The maker fee. This value is normalized to 0–1 range (where 0.15 assumes the fee of 15%).
takerFee number: The taker fee. This value is normalized to 0–1 range (where 0.15 assumes the fee of 15%).
tier_group_id number: The tier group to which this tier belongs.

    RESPONSE EXAMPLE
  
{
  "id": 3,
  "description": "fourth tier",
  "volume": 100000000,
  "maker_fee": 0.006,
  "taker_fee": 0.006,
  "tier_group_id": 1
}

Update tier settings

Use this method to configure a tier.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters:

tier_id required: The tier identifier.

Body:

description string: The tier title.
volume number: The minimum asset volume that must be traded for special taker and maker fees to apply.
makerFee number: The maker fee. This value is normalized to 0–1 range (where 0.15 assumes the fee of 15%).
takerFee number: The taker fee. This value is normalized to 0–1 range (where 0.15 assumes the fee of 15%).

PUT[host]/back-api/backoffice/tiers/tier/{tier_id}

PUT /back-api/backoffice/tiers/tier/3 HTTP/1.1
Host: host.name
Authorization: Bearer akvmn34egjidg0jifgjdg0djg34g

{
  "description": "fourth tier",
  "volume": 100000000,
  "maker_fee": 0.005,
  "taker_fee": 0.006
}

Response

id number: The tier identifier.
description string: The tier title.
volume number: The minimum asset volume that must be traded for special taker and maker fees to apply.
makerFee number: The maker fee. This value is normalized to 0–1 range (where 0.15 assumes the fee of 15%).
takerFee number: The taker fee. This value is normalized to 0–1 range (where 0.15 assumes the fee of 15%).
tier_group_id number: The tier group to which this tier belongs.

    RESPONSE EXAMPLE
  
{
  "id": 3,
  "description": "fourth tier",
  "volume": 100000000,
  "maker_fee": 0.005,
  "taker_fee": 0.006,
  "tier_group_id": 1
}

Remove a tier

Use this method to discontinue a tier and remove it from the tier list.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters:

tier_id required: The tier identifier.

DELETE[host]/back-api/backoffice/tiers/tier/{tier_id}

DELETE /back-api/backoffice/tiers/tier/3 HTTP/1.1
Host: host.name
Authorization: Bearer akvmn34egjidg0jifgjdg0djg34g

Response

In case of success, HTTP code 200 is returned.

Get a tier group list

Use this method to view the identifier and title of each tier group.

Request

Header parameters:

Authorization: Bearer <access_token>

GET[host]/back-api/backoffice/tiers/group

GET /back-api/backoffice/tiers/group HTTP/1.1
Host: host.name
Authorization: Bearer akvmn34egjidg0jifgjdg0djg34g

Response

id number: The tier group identifier.
description string: The tier group title.

    RESPONSE EXAMPLE
  
[
  {
    "id": 1,
    "description": "group for crypto-crypto instruments"
  }
]

Create a tier group

Use this method to create a new tier group, after which you can start introducing new tiers on the exchange.

Request

Header parameters:

Authorization: Bearer <access_token>

Body:

description string: The tier group title.

POST[host]/back-api/backoffice/tiers/group

POST /back-api/backoffice/tiers/group HTTP/1.1
Host: host.name
Authorization: Bearer akvmn34egjidg0jifgjdg0djg34g

{
  "description": "group for crypto-crypto instruments"
}

Response

id number: The tier group identifier.
description string: The tier group title.

    RESPONSE EXAMPLE
  
{
  "id": 1,
  "description": "group for crypto-crypto instruments"
}

Update the tier group title

Use this method to change the title of a tier group.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters:

group_id: The tier group identifier.

Body:

description string: The new tier group title.

PUT[host]/back-api/backoffice/tiers/group/{group_id}

PUT /back-api/backoffice/tiers/group/1 HTTP/1.1
Host: host.name
Authorization: Bearer akvmn34egjidg0jifgjdg0djg34g

{
  "description": "group for crypto-fiat instruments"
}

Response

id number: The tier group identifier.
description string: The new tier group title.

    RESPONSE EXAMPLE
  
{
  "id": 1,
  "description": "group for crypto-fiat instruments"
}

Remove a tier group

Use this method to remove an existing tier group.

Important

A tier group is removed along with all tiers that were added to it.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters:

group_id required: The tier group identifier.

DELETE[host]/back-api/backoffice/tiers/group/{group_id}

DELETE /back-api/backoffice/tiers/group/1 HTTP/1.1
Host: host.name
Authorization: Bearer akvmn34egjidg0jifgjdg0djg34g

Response

In case of success, HTTP code 200 is returned.

Get a list of tier markets

Use this method to identify the markets covered by a tier group.

Request

Header parameters:

Authorization: Bearer <access_token>

GET[host]/back-api/backoffice/tiers/market

GET /back-api/backoffice/tiers/market HTTP/1.1
Host: host.name
Authorization: Bearer akvmn34egjidg0jifgjdg0djg34g

Response

marketId string: The market identifier (such as btc_usdt): {baseAsset}_{quoteAsset}.
tierGroupId number: The tier group that includes this market.

    RESPONSE EXAMPLE
  
[
  {
    "marketId": "btc_eur",
    "tierGroupId": 1
  }
]

Add a market to a tier group

Use this method to extend the tier group reach by linking a new market to it.

Note

Each market can only be listed by a single tier group.

On an attempt to list a market assigned to another group, an error is returned.

Request

Header parameters:

Authorization: Bearer <access_token>

Body:

tierGroupId number: The tier group identifier.
marketId string: The market identifier (such as btc_usdt): {baseAsset}_{quoteAsset}.

POST[host]/back-api/backoffice/tiers/market

POST /back-api/backoffice/tiers/market HTTP/1.1
Host: host.name
Authorization: Bearer akvmn34egjidg0jifgjdg0djg34g

{
  "tierGroupId": 1,
  "marketId": "btc_usd"
}

Response

tierGroupId number: The tier group identifier.
marketId string: The market identifier (such as btc_usdt): {baseAsset}_{quoteAsset}.

    RESPONSE EXAMPLE
  
{
  "tierGroupId": 1,
  "marketId": "btc_usd"
}

Remove a market from a tier group

Use this method to remove a specific market from a tier group.

Request

Header parameters:

Authorization: Bearer <access_token>

Path parameters:

market_id required: The market identifier.

DELETE[host]/back-api/backoffice/tiers/market/{market_id}

DELETE /back-api/backoffice/tiers/market/btc_usd HTTP/1.1
Host: host.name
Authorization: Bearer akvmn34egjidg0jifgjdg0djg34g

Response

In case of success, HTTP code 200 is returned.