Users & Accounts Management

Accounts

Download Spec

All accounts related paths

get/users/{user_id}/accounts

Get user accounts

Lists the accounts of a user specified by ID.

sortstring

Sort the result by created_at, updated_at.

Default: "created_at"
Enum: created_at
updated_at

orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default: "ASC"
Enum: ASC
DESC

offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format: int32
Min: 0

limitint

Use the limit argument to specify the maximum number of items returned.

Format: int32
Default: 100
Min: 0
Max: 1000

Responses

Response examples

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd",
      "created_at": "2020-08-24T14:15:22Z",
      "updated_at": "2020-08-24T14:15:22Z",
      "account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
      "type": "TRADING",
      "users": [
        {
          "id": "9c36af78-91a0-4174-a515-fc81214e3dab",
          "type": "OWNER"
        }
      ],
      "account_number": 1,
      "name": "Main account",
      "status": "ACTIVE"
    }
  ]
}

get/accounts/{account_id}

Get account by ID

Returns the account specified by its ID.

account_idstring

required

Account unique identifier.

Format: uuid

Responses

Response examples

{
  "id": "ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd",
  "created_at": "2020-08-24T14:15:22Z",
  "updated_at": "2020-08-24T14:15:22Z",
  "account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
  "type": "TRADING",
  "users": [
    {
      "id": "9c36af78-91a0-4174-a515-fc81214e3dab",
      "type": "OWNER"
    }
  ],
  "account_number": 1,
  "name": "Main account",
  "status": "ACTIVE"
}

delete/accounts/{account_id}

Close account by ID

Initiates the closure request for an account specified by its ID.

account_idstring

required

Account unique identifier.

Format: uuid

Responses

Response examples

The request has been successfully accepted and will be processed asynchronously.

Empty response

patch/accounts/{account_id}

Update account by ID

Updates the account specified by its ID.

namestring

The name of the account.

Max Length: 100

Responses

Request examples

{
  "name": "Main account"
}

Response examples

Account updated.

{
  "id": "ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd",
  "created_at": "2020-08-24T14:15:22Z",
  "updated_at": "2020-08-24T14:15:22Z",
  "account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
  "type": "TRADING",
  "users": [
    {
      "id": "9c36af78-91a0-4174-a515-fc81214e3dab",
      "type": "OWNER"
    }
  ],
  "account_number": 1,
  "name": "Main account",
  "status": "ACTIVE"
}

get/accounts

Get accounts

Returns a list of all accounts.

sortstring

Sort the result by created_at, updated_at§.

Default: "created_at"
Enum: created_at
updated_at

orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default: "ASC"
Enum: ASC
DESC

offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format: int32
Min: 0

limitint

Use the limit argument to specify the maximum number of items returned.

Format: int32
Default: 100
Min: 0
Max: 1000

Responses

Response examples

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "created_at",
    "order": "ASC"
  },
  "data": [
    {
      "id": "ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd",
      "created_at": "2020-08-24T14:15:22Z",
      "updated_at": "2020-08-24T14:15:22Z",
      "account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
      "type": "TRADING",
      "users": [
        {
          "id": "9c36af78-91a0-4174-a515-fc81214e3dab",
          "type": "OWNER"
        }
      ],
      "account_number": 1,
      "name": "Main account",
      "status": "ACTIVE"
    }
  ]
}

post/accounts

Create an account

Creates an account.

user_idstring

required

User unique identifier.

Format: uuid

account_group_idstring

required

Account group unique identifier.

Format: uuid

typestring

required

Account type.

TRADING - Orders in accounts of this type are created on a specific instrument basis.
PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available.

Enum: TRADING
PORTFOLIO

namestring

The name of the account.

Max Length: 100

Responses

Request examples

{
  "user_id": "413715f2-5401-4b97-8055-034a6b879f8c",
  "account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
  "type": "TRADING",
  "name": "Main account"
}

Response examples

Account created.

{
  "id": "ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd",
  "created_at": "2020-08-24T14:15:22Z",
  "updated_at": "2020-08-24T14:15:22Z",
  "account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
  "type": "TRADING",
  "users": [
    {
      "id": "9c36af78-91a0-4174-a515-fc81214e3dab",
      "type": "OWNER"
    }
  ],
  "account_number": 1,
  "name": "Main account",
  "status": "ACTIVE"
}

webhook

Account events

idstring

required

Event unique identifier

Format: uuid

created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format: date-time

typestring

required

Event type

Enum: ACCOUNT.CREATED
ACCOUNT.ACTIVATED
ACCOUNT.CLOSING_INITIATED
ACCOUNT.CLOSED
ACCOUNT.LOCKED
ACCOUNT.UPDATED

objectobject (Account)

required

idstring

required

Account unique identifier.

Format: uuid

created_atstring

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

Format: date-time

updated_atstring

required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

Format: date-time

account_group_idstring

required

Account group unique identifier.

Format: uuid

typestring

required

Account type.

TRADING - Orders in accounts of this type are created on a specific instrument basis.
PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available.

Enum: TRADING
PORTFOLIO

usersarray

required

account_numberint

required

The serial account number of the account in the account group.

Min: 1

namestring

required

The name of the account.

Max Length: 100

statusstring

required

The status of the account

PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on.
ACTIVE - Account is active - full functionality of the Investment API is accessible.
CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed.
CLOSED - Account is closed with zero balance successfully.
LOCKED - Account is locked for all actions.

Enum: PENDING_APPROVAL
ACTIVE
CLOSING
CLOSED
LOCKED

webhook_idstring

required

Webhook unique identifier.

Format: uuid

Responses

Request examples

{
  "id": "56510309-d9de-4730-9b5b-4a0ed047f3a9",
  "created_at": "2021-07-21T14:10:00.00Z",
  "type": "ACCOUNT.CREATED",
  "object": {
    "id": "ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd",
    "created_at": "2020-08-24T14:15:22Z",
    "updated_at": "2020-08-24T14:15:22Z",
    "account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
    "type": "TRADING",
    "users": [
      {
        "id": "9c36af78-91a0-4174-a515-fc81214e3dab",
        "type": "OWNER"
      }
    ],
    "account_number": 1,
    "name": "Main account",
    "status": "ACTIVE"
  },
  "webhook_id": "b838bde5-b6df-4f1f-bfc4-71d3fb01d430"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?