Home B2Core IB API Symbols

Symbols

On this page:

THE SYMBOL OBJECT	A detailed description of the JSON object
THE PAYMENT PLAN OBJECT	A detailed description of the JSON object
THE SYMBOL GROUP OBJECT	A detailed description of the JSON object
GET[base]/symbols	Get a symbols list
GET[base]/symbols/{symbolId}	Get symbol details
GET[base]/symbols/{symbolId}/metrics	Get symbol metrics
GET[base]/symbols/groups	Get a symbol groups list
GET[base]/symbols/groups/{symbolGroupId}	Get symbol group details
GET[base]/symbols/{symbolId}/preferences	Get a payment plans list
GET[base]/symbols/{symbolId}/preferences/{paymentPlanId}	Get a payment plans list
POST[base]/symbols/{symbolId}/preferences	Add a new payment plan
PUT[base]/symbols/{symbolId}/preferences/{paymentPlanId}	Update a payment plan
DELETE[base]/symbols/{symbolId}/preferences/{paymentPlanId}	Delete a payment plan

The Symbol object

This object provides the following data about a symbol:

symbolId string

The symbol identifier.

symbolGroupId string

The symbol group identifier.

platformGroupId string

The platform group identifier.

platformId string

The trading platform identifier.

description string

The symbol description.

name string

The hierarchical symbol path: platform group\\symbol group\\symbol name

symbol string

The symbol name.

quoteCurrencyCode string

The alphabetic code of a quote currency.

isForexable boolean

Deprecated.

contractSize string

The contract size.

point string

The smallest unit of price change quoted.

environment string

The working environment. Possible values:

production
demo

archived boolean

The symbol status on a trading platform: true if archived, otherwise false.

createTime string

The date and time when the object has been created.

updateTime string

The date and time when the object has been last updated.

uuid string

The unique universal identifier of the object (if provided). Refer to Integrations for more information.

    THE SYMBOL OBJECT
  
{
  "symbolId": "6006dda272f002519c3eb505",
  "symbolGroupId": "6006dda272f002519c3eb505",
  "platformGroupId": "6006dda272f002519c3eb505",
  "platformId": "6006dda272f002519c3eb505",
  "description": "Apple Inc.",
  "name": "B2BUSD\\Shares\\AAPL",
  "symbol": "AAPL",
  "quoteCurrencyCode": "BTC",
  "isForexable": true,
  "contractSize": "1.000000000000000000",
  "point": "1.000000000000000000",
  "environment": "production",
  "archived": true,
  "createTime": "2021-01-01T00:00:00+00:00",
  "updateTime": "2021-01-01T00:00:00+00:00",
  "uuid": null
}

The Symbol group object

This object provides the following data about a symbol group:

symbolGroupId string

The symbol group identifier.

platformGroupId string

The platform group identifier.

platformId string

The trading platform identifier.

environment string

The working environment. Possible values:

production
demo

name string

The hierarchical symbol group path: platform group\\symbol group

    THE SYMBOL GROUP OBJECT
  
{
  "symbolGroupId": "6006dda272f002519c3eb505",
  "platformGroupId": "6006dda272f002519c3eb505",
  "platformId": "6006dda272f002519c3eb505",
  "environment": "production",
  "name": "B2BUSD\\Shares"
}

The Payment plan object

This object provides the following data about a payment plan configured for a symbol or a symbol group:

preferenceId string

The preference identifier.

formula string

The payment plan. Possible values:

commission — Commission
lot — Lot
max_amount — Max amount
markup — Markup
percentage — Markup %

levelTable object

The multipliers for reward calculation for different levels. Applicable for max_amount payment plan only.

ratio string

The multiplier for reward calculation.

unit string

The alphabetic currency code.

position string

The position state. Possible values:

open
close

scope object

The scope to which the payment plan settings are applied. Possible values:

groupId
name
uuid

precision integer

The minor unit of a currency (the number of digits after the decimal separator).

createTime string

The date and time when the object has been created.

updateTime string

The date and time when the object has been last updated.

uuid string

The unique universal identifier of the object (if provided). Refer to Integrations for more information.

    THE PAYMENT PLAN OBJECT
  
{
  "preferenceId": "6006dda272f002519c3eb505",
  "formula": "max_amount",
  "levelTable": {
    "2": [
      "0.8",
      "0.3"
    ],
    "3": [
      "0.7",
      "0.15",
      "0.15"
    ]
  },
  "ratio": "1.000000000000000000",
  "unit": "BTC",
  "position": "open",
  "scope": {
    "groupId": "6006dda272f002519c3eb505",
    "name": "Standard",
    "uuid": null
  },
  "precision": 8,
  "createTime": "2021-01-01T00:00:00+00:00",
  "updateTime": "2021-01-01T00:00:00+00:00",
  "uuid": null
}

Get a symbols list

Use this method to obtain a list of symbols on a trading platform.

To obtain detailed information about a specified symbol, use a separate method to get symbol details.

Request

Header parameters:

Authorization: Bearer <token>

Query parameters:

This method supports pagination, sorting, filtering, and query. For details on applying the parameters, refer to the Query parameters section. Possible parameters for filtering, sorting, and query are listed below. For values description, refer to the Symbol object.

Possible values for the filter parameter:

archivedFilter
symbolDescription
symbolName
symbolQuoteCurrencyCode
platformId
symbolParentId
symbolPathName
symbolProvider
uuid

Possible values for the sort_by parameter:

archived
createTime (default)
name
symbol
symbolId
quoteCurrencyCode
trades
updateTime

Possible values for the query parameter:

metrics — information about the total number of trades on a symbol (see also: Get symbol metrics)
group — information about the platform group and symbol group
platform — information about the trading platform
preferences — information about the configured payment plan

GET[base]/symbols

curl --location -g --request GET 'https://your.base-url.here/symbols?limit=10&offset=0&sort_by=createTime&sort_order=desc&filter[archived]=<boolean>&filter[description]=Lemonade  Inc.&filter[symbolName]=BTCUSD&filter[quoteCurrencyCode]=BTC&filter[platformId]=6006dda272f002519c3eb505&filter[parentId]=6006dda272f002519c3eb505&filter[name]=demo\testing\No Used\BTCUSD.&filter[provider]=metatrader5&filter[uuid]=9&query[metrics]=1&query[group]=1&query[platform]=1&query[preferences]=1' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains an array of Symbol objects providing information about all symbols that correspond to the query parameters specified in the request.

Additionally, the response body may contain the following information if any of these were specified in the query parameters of the request:

the metrics array providing information about the total number of trades
the Symbol group and Platform group objects
the Platform object
the Payment plan object

Get symbol details

Use this method to obtain detailed information about a specified symbol.

To obtain a list of symbols on a trading platform, use a separate method to get a list of symbols.

Request

Header parameters:

Authorization: Bearer <token>

Path parameters:

symbolId required: The symbol identifier.

Query parameters:

This method supports query. For details on applying the parameters, refer to the Query parameters section.

Possible values for the query parameter:

metrics — information about the total number of trades
group — information about the platform group and symbol group
platform — information about the trading platform
preferences — information about the configured payment plan

GET[base]/symbols/{symbolId}

curl --location -g --request GET 'https://your.base-url.here/symbols/60ba407d15951453e60e49f8?query[metrics]=1&query[group]=1&query[platform]=1&query[preferences]=1' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains a Symbol object providing information about the specified symbol.

Additionally, the response body may contain the following information if any of these were specified in the query parameters of the request:

the metrics array providing information about the total number of trades
the Symbol group and Platform group objects
the Platform object
the Payment plan object

Get symbol metrics

Use this method to obtain information about the number of trades on a specified symbol.

Request

Header parameters:

Authorization: Bearer <token>

Path parameters:

symbolId required: The symbol identifier.

GET[base]/symbols/{symbolId}/metrics

curl --location --request GET 'https://your.base-url.here/symbols/60ba407d15951453e60e49f8/metrics' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains a key-value pair providing information about the number of trades on the specified symbol.

    RESPONSE BODY EXAMPLE
  
{
  "total": 1,
  "metrics": [
    {
      "key": "trades",
      "value": 2487447
    }
  ]
}

Get a symbol groups list

Use this method to obtain a list of symbol groups.

To obtain detailed information about a specified symbol group, use a separate method to get symbol group details.

Request

Header parameters:

Authorization: Bearer <token>

Query parameters:

Possible values for the filter parameter:

platformId
symbolPathName
symbolProvider
uuid

Possible values for the sort_by parameter:

createTime (default)
name
updateTime

Possible values for the query parameter:

metrics — information about the total number of trades on a symbol
group — information about the platform group and symbol group
platform — information about the trading platform

GET[base]/symbols/groups

curl --location -g --request GET 'https://your.base-url.here/symbols/groups?limit=10&offset=0&sort_by=createTime&sort_order=desc&filter[platformId]=6006dda272f002519c3eb505&filter[name]=demo\testing\No Used\BTCUSD.&filter[provider]=metatrader5&filter[uuid]=9&query[group]=1&query[platform]=1&query[metrics]=1' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains an array of Symbol group objects providing information about all symbol groups that correspond to the query parameters specified in the request.

Additionally, the response body may contain the following information if any of these were specified in the query parameters of the request:

the metrics array providing information about the total number of trades
the Symbol group and Platform group objects
the Platform object

Get symbol group details

Use this method to obtain detailed information about a specified symbol group.

To obtain a list of symbol groups, use a separate method to get a list of symbol groups.

Request

Header parameters:

Authorization: Bearer <token>

Path parameters:

symbolGroupId required: The symbol group identifier.

Query parameters:

This method supports query. For details on applying the parameters, refer to the Query parameters section.

Possible values for the query parameter:

metrics — information about the total number of trades on a symbol
group — information about the platform group and symbol group
platform — information about the trading platform

GET[base]/symbols/groups/{symbolGroupId}

curl --location -g --request GET 'https://your.base-url.here/symbols/groups/60ba407d15951453e60e49f8?query[group]=1&query[platform]=1&query[metrics]=1' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains a Symbol group object providing information about the specified symbol group.

Additionally, the response body may contain the following information if any of these were specified in the query parameters of the request:

the metrics array providing information about the total number of trades
the Symbol group and Platform group objects
the Platform object

Get a payment plans list

Use this method to obtain information about payment plans configured for a specified symbol.

To obtain detailed information about a specified payment plan, use a separate method to get payment plan details.

Request

Header parameters:

Authorization: Bearer <token>

Path parameters:

symbolId required: The symbol identifier.

GET[base]/symbols/{symbolId}/preferences

curl --location --request GET 'https://your.base-url.here/symbols/60ba407d15951453e60e49f8/preferences' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains an array of Payment plan object providing information about all payment plans configured for a specified symbol.

Get payment plan details

Use this method to obtain detailed information about a specified payment plan.

To obtain a list of payment plans, use a separate method to get a list of payment plans.

Request

Header parameters:

Authorization: Bearer <token>

Path parameters:

symbolId required: The symbol identifier.
paymentPlanId required: The payment plan identifier.

GET[base]/symbols/{symbolId}/preferences/{paymentPlanId}

curl --location --request GET 'https://your.base-url.here/symbols/60ba407d15951453e60e49f8/preferences/60ba407d15951453e60e49f8' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains a Payment plan object providing information about the specified payment plan.

Add a new payment plan

Use this method to add a new payment plan for a specified symbol.

Request

Header parameters:

Authorization: Bearer <token>
Content-Type: application/json

Path parameters:

symbolId required: The symbol identifier.

Body:

groupId string required

The symbol group identifier on a trading platform.

formula string required

The payment plan. Possible values:

commission — Commission
lot — Lot
max_amount — Max amount
markup — Markup
percentage — Markup %

levelTable object

The multipliers for reward calculation for different levels. Applicable for max_amount payment plan only.

position string

The position state. Possible values:

open
close

side string

The trade side. The following object fields are available: buy, sell.

ratio string required

The multiplier for reward calculation.

unit string

The alphabetical currency code.

uuid string

The unique universal identifier of the object. Refer to Integrations for more information.

POST[base]/symbols{symbolId}/preferences

curl --location --request POST 'https://your.base-url.here/symbols/60ba407d15951453e60e49f8/preferences' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "groupId": "6006dda272f002519c3eb505",
  "formula": "max_amount",
  "ratio": "1.000000000000000000",
  "levelTable": {
    "2": [
      "0.8",
      "0.3"
    ],
    "3": [
      "0.7",
      "0.15",
      "0.15"
    ]
  },
  "position": "open",
  "side": "buy",
  "unit": "BTC",
  "uuid": null
}'

Response

Body:

In case of success, the response body contains a Payment plan object providing information about the newly created payment plan.

Update a payment plan

Use this method to update a specified payment plan.

Note

Instead of the method described below, you can use a similar method that uses the HTTP verb PATCH.

Request

Header parameters:

Authorization: Bearer <token>
Content-Type: application/json

Path parameters:

symbolId required: The symbol identifier.
paymentPlanId required: The payment plan identifier.

Body:

The values of the following fields can be updated:

groupId string required

The symbol group identifier on a trading platform.

formula string required

The payment plan. Possible values:

commission — Commission
lot — Lot
max_amount — Max amount
markup — Markup
percentage — Markup %

levelTable object

The multipliers for reward calculation for different levels. Applicable for max_amount payment plan only.

position string

The position state. Possible values:

open
close

side string

The trade side. The following object fields are available: buy, sell.

ratio string required

The multiplier for reward calculation.

unit string

The alphabetical currency code.

uuid string

The unique universal identifier of the object. Refer to Integrations for more information.

PUT[base]/symbols/{symbolId}/preferences/{paymentPlanId}

curl --location --request PUT 'https://your.base-url.here/symbols/60ba407d15951453e60e49f8/preferences/60ba407d15951453e60e49f8' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "groupId": "6006dda272f002519c3eb505",
  "formula": "max_amount",
  "levelTable": {
    "2": [
      "0.8",
      "0.3"
    ],
    "3": [
      "0.7",
      "0.15",
      "0.15"
    ]
  },
  "position": "open",
  "side": "buy",
  "ratio": "1.000000000000000000",
  "unit": "BTC",
  "uuid": null
}'

Response

Body:

In case of success, the response body contains a Payment plan object providing information about the updated payment plan.

Delete a payment plan

Use this method to delete a specified payment plan.

Request

Header parameters:

Authorization: Bearer <token>

Path parameters:

symbolId required: The symbol identifier.
paymentPlanId required: The payment plan identifier.

DELETE[base]/symbols/{symbolId}/preferences/{paymentPlanId}

curl --location --request DELETE 'https://your.base-url.here/symbols/60ba407d15951453e60e49f8/preferences/60ba407d15951453e60e49f8' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, no response body is returned.