Describe one financial dataset and its fields.

Describe one financial dataset and its fields.

get/v1/data/schema

Request

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

Query parameters

datasetstring required

The dataset to describe. candor data list names them.

Response

Dataset schema envelope.

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.