List compact investment holdings or return one full holding by id.

List compact investment holdings or return one full holding by id.

get/v1/holdings

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/holdings
  • Auth: HTTP bearer

Query parameters

idstring

Return this one full holding instead of a list. Use the exact id a prior call returned.

limitinteger

Maximum records to return in one page. The supported range is 1 through 1000; the default stays small.

cursorstring

Continue the same filtered read from pagination.next_cursor. The cursor is bound to the exact filters of the read that issued it; replay every other argument unchanged, or start again without cursor.

source_account_idstring

Restrict positions to one visible source account.

Response

Response containing compact investment holdings, or one full holding with provenance when id is supplied.

schema_versionstring required
generated_atstring date-time required
request_idstring required
status'success' | 'partial_success' | 'action_required' | 'error' required
user_messagestring

Optional concise user-safe message the calling agent may adapt.

warningsobject[] required
dataobject nullable required

Operation-specific result data, or null when the request ends in an error.

Changes

No recorded changes to this operation across all 1 revision of this API.