API Reference

Account

Introduction

Read the organization account status.

Description

The organization account status includes the organization Id, QCC balance, and credit card information.

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": "string",
    "last4": "string"
  }
}
Card Model - Credit card information.
brand string
Credit card brand.
expiration string
The credit card expiration (mm/yy).
last4 string
The last 4 digits of the card.
Example 
{
  "brand": "string",
  "expiration": "string",
  "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

Examples

The following example demonstates reading the organization account status through the cloud API.

from base64 import b64encode
from hashlib import sha256
from time import time
from requests import get, post
BASE_URL = 'https://www.quantconnect.com/api/v2/'

# You need to replace these with your actual credentials.
# You can request your credentials at https://www.quantconnect.com/settings/
# You can find our organization ID at https://www.quantconnect.com/organization/ 
USER_ID = 0
API_TOKEN = '____'
ORGANIZATION_ID = '____'

def get_headers():
    # Get timestamp
    timestamp = f'{int(time())}'
    time_stamped_token = f'{API_TOKEN}:{timestamp}'.encode('utf-8')

    # Get hased API token
    hashed_token = sha256(time_stamped_token).hexdigest()
    authentication = f'{USER_ID}:{hashed_token}'.encode('utf-8')
    authentication = b64encode(authentication).decode('ascii')

    # Create headers dictionary.
    return {
        'Authorization': f'Basic {authentication}',
        'Timestamp': timestamp
    }

# Authenticate to verify credentials
response = post(f'{BASE_URL}/authenticate', headers = get_headers())
print(response.json())

# --------------------


### Read Account Status
# Send a POST request to the /account/read endpoint to read account status
response = post(f'{BASE_URL}/account/read', headers=get_headers())
# Parse the JSON response into python managable dict
result = response.json()
# Check if the request was successful and print the account status
if result['success']:
    print("Account Status:")
    print(result)

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: