Authentication

Cumulus9's API uses an API Key for authentication. To access API endpoints, include your API Key in the Authorization header as a Bearer token.

Using your API Key

Use your API Key directly in every API request.

Endpoint

POST {baseUrl}/portfolios

Request Headers

Authorization: "Bearer your_api_key"
Content-Type: "application/json"

Request Body

{
  "calculation_type": "margins",
  "execution_mode": "sync",
  "portfolio": [...]
}

Example

cURL request

curl -X POST "{baseUrl}/portfolios" \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{ "portfolio": [...] }'

Successful Response

{
  "request_id": "64224eba...",
  "data": [...]
}

If you encounter authentication errors, ensure that:

Your API Key is correct and active.
The Authorization header is properly formatted (Bearer your_api_key).