Home B2Core IB API Geographic regions

Geographic regions

On this page:

THE GEOGRAPHIC REGION OBJECT

A detailed description of the JSON object

GET[base]/regions

Get a geographic regions list

GET[base]/regions/{regionId}

Get geographic region details

The Geographic region object

This object provides the following data about a trading account:

regionId string

The geographic region identifier.

regionName string

The geographic region name, as per UN M49.

numericCode string

The geographic region numeric code, as per UN M49.

parentRegionId string

The identifier of the parent region, as per UN M49.

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.

THE GEOGRAPHIC REGION OBJECT 
{
  "regionId": "6006dda272f002519c3eb505",
  "regionName": "Northern America",
  "numericCode": "021",
  "parentRegionId": "6006dda272f002519c3eb506",
  "createTime": "2021-01-01T00:00:00+00:00",
  "updateTime": "2021-01-01T00:00:00+00:00"
}

Get a geographic regions list

Use this method to obtain a list of geographic regions.

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

Request

Header parameters:

  • Authorization: Bearer <token>

Query parameters:

This method supports pagination, sorting, and filtering. 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 Geographic region object.

Possible values for the filter parameter:

  • regionName

  • regionNumericCode

  • regionParentId

Possible values for the sort_by parameter:

  • regionId

  • regionName

  • numericCode

  • createTime (default)

  • updateTime

GET[base]/regions

curl --location -g --request GET 'https://your.base-url.here/regions?limit=10&offset=0&sort_by=createTime&sort_order=desc&filter[name]=Northern America&filter[regionNumericCode]=021&filter[parentId]=6006dda272f002519c3eb505' \
--header 'Authorization: Bearer <token>'

Response

Body:

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

Get geographic region details

Use this method to obtain detailed information about a specified geographic region.

To obtain a list of geographic regions, use a separate method to get a list of geographic regions.

Request

Header parameters:

  • Authorization: Bearer <token>

Path parameters:

regionId required

The geographic region identifier.

GET[base]/regions/{regionId}

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

Response

Body:

In case of success, the response body contains a Geographic region object providing information about the specified geographic region.