book
Checkout our new book! Hands on AI Trading with Python, QuantConnect, and AWS Learn More arrow

API Reference

Account

Introduction

None

Description

Will read the organization account status.

Request

The /account/read API accepts requests in the following format:

/account/read Method
/account/read method takes no parameters.

Responses

The /account/read API provides a response in the following format:

200 Success

AccountResponse Model - Account information for an organization.
organizationId string
The organization Id.
creditBalance number
The current account balance.
card Card object
Credit card information.
Example
{
  "organizationId": "string",
  "creditBalance": 0,
  "card": {
    "brand": "string",
    "expiration": "2021-11-26T15:18:27.693Z",
    "last4": "string"
  }
}
Card Model - Credit card information.
brand string
Credit card brand.
expiration string($date-time)
The credit card expiration.
last4 string
The last 4 digits of the card.
Example
{
  "brand": "string",
  "expiration": "2021-11-26T15:18:27.693Z",
  "last4": "string"
}

401 Authentication Error

UnauthorizedError Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.
www_authenticate string
Header

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: