Skip to navigation
API ReferenceAccounts

Get Account Allocation

Returns an account’s allocations for a run date. Allocations are produced only on business days, so a weekend or holiday run_date returns an empty allocations list. When run_date is omitted, the most recent approved allocation run is used. To get the latest allocations, omit run_date; if you pass a date, use a business day.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Query parameters

id_typeenum or nullOptional
Type of the account id. Must be 'institution' or 'None'.
Allowed values:
run_datestring or nullOptionalformat: "date"

The date for which to retrieve allocation data. Must be a business day to return allocations; weekend and holiday dates return an empty list. If not provided, uses the most recent approved allocation run date.

Response

Successful Response
account_idstring
run_datestring
allocationslist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error