Certificate Holdings

Retrieve the list of all monthly certificates held by the API user (hourly certificates are not included). This will return certificates belonging to the API user that are in active and retired states.

SecurityJWT
Request
query Parameters
accountIds
Array of strings

Account ids: if specified, limits results to the items related to the accounts whose ids match the provided set; otherwise, all results related to any authorized account will be returned

vintageStart
string <date-time>

Vintage start (inclusive)

vintageEnd
string <date-time>

Vintage end (exclusive)

subaccountTypeCode
string

Subaccount type code. If not specified, holdings will be returned regardless of status.

$filter
string

OData-like filter expression

$orderby
string

Comma-separated list of columns for sorting

$skip
integer <int32>

Number of records to skip

$top
integer <int32>

Maximum number of records to return

$apply
string

OData-like apply expression with groupby and aggregate only

Responses
200

Success

400

Invalid parameter(s)

401

Unauthorized access

403

Permission denied

429

Server too busy or acceptable use policy violation

500

An unexpected error has occurred

get/api/ledger/holding
Response samples
application/json
{
  • "@count": 0,
  • "value": [
    ],
  • "totalCount": 0,
  • "countExceeded": true
}