sloe/ developers
API reference

Return quarterly data-feed metadata or issue a short-lived download broker link

Published REST contract · Bearer authentication · Download OpenAPI

Response examples are generated from the schema and contain placeholders; they are not live institution records. Run requests from your server with your own Data Access key.

GET
/api/data-feed

Without a file parameter, returns the deployable manifest for a licensed quarterly feed. With file=archive or a package filename, returns a 302 redirect to a short-lived broker URL when backing storage is configured.

Authorization

bearerApiKey
headerAuthorizationBearer <CUWIREDATA_API_KEY>

Send as Authorization: Bearer <CUWIREDATA_API_KEY>. Keys must have tier data_access.

Query Parameters

period?string

Quarterly package period. Defaults to the current promoted period when omitted.

Match^\d{4}-Q[1-4]$
file?string

Use archive for the full package, or a manifest path such as institutions.csv or institutions.parquet.

platform_release_id?string

Pin the current platform artifact release. A mismatch returns 409. Reuse the X-CUWire-Release response header.

Response Body

Manifest metadata

application/json
  1. response
ok*boolean
trace_id*string
data*
Example Request
curl --fail-with-body --silent --show-error 'https://sloedata.com/api/data-feed' \  -H "Authorization: Bearer $SLOE_API_KEY"
Example Response
{  "ok": true,  "trace_id": "string",  "data": {    "product": "string",    "package_version": 0,    "generated_at": "2019-08-24T14:15:22Z",    "period": "string",    "cycle_date": "2019-08-24",    "coverage": {},    "files": [      {        "path": "string",        "rows": 0,        "bytes": 0,        "sha256": "string",        "href": "string",        "format": "parquet",        "source_file": "string",        "source_sha256": "string"      }    ],    "api": {      "endpoint": "string",      "auth": "string",      "query_keys_allowed": false,      "origin": "string"    },    "archive": {      "path": "string",      "href": "string"    },    "cycle": "string",    "person_level_fields_excluded": true,    "executive_data_excluded": true,    "notes": [      "string"    ],    "application_financial_release": {      "id": "string",      "metric_version": "string",      "history_scope": "string",      "limitation": "string"    },    "delivery": {},    "delivery_revision": "string",    "available_periods": [      {        "period": "string",        "scope": "string",        "href": "string",        "formats": [          "string"        ]      }    ]  }}