Flat file metadata and download
Metadata for one file, or with download=true the file itself: usually a 302 redirect to a presigned URL that is valid for five minutes and needs no API key, otherwise the gzip stream. Verify X-Content-SHA256. Requires flat-files.read (Pro, Commercial and Scale), the dataset capability (eod.read or corporate-actions.read), the US market and a date within the plan history depth. CSV files are UTF-8 with a header row; empty fields are null, instants are UTC RFC 3339 with microseconds, prices and volumes are exact decimal strings, booleans are true or false, and corporate-action legs are a JSON array. Each row carries instrument_id, the stable ID the REST endpoints return, as its last column; security_id holds the same value and is deprecated.
/v1/flat-files/{dataset}/{date}- Required capability
- flat-files.read
- Data timing
- Nightly files
- Credits
- 5 credits per request; 500 credits to download the file.
Parameters
datasetstringrequired · path- eod or corporate-actions.
eodcorporate-actions datestringrequired · path- New York trading date (YYYY-MM-DD).
downloadbooleanoptional · query- Set true to download the .csv.gz file instead of its JSON metadata.Default:
false
Response fields
Returns data as an object. All example values are illustrative.
datasetstring- dataset
eodcorporate-actions marketstring- market
datestring- New York trading date the file covers.
rowsinteger- Data rows, excluding the header row.
bytesinteger- Size of the .csv.gz file.
sha256string- SHA-256 of the .csv.gz file; changes when the file is republished.
generated_atstring- When this version was published; also its knowledge cutoff.
download_pathstring- Relative URL that downloads the file.
Response metadata
Responses include meta.timezone. Dataset responses include next_cursor; health and exports have their own metadata. Request tracing uses the X-Request-ID header.
When something goes wrong
An empty data: [] is a successful query with no matching records. Invalid symbols, permissions and malformed parameters produce an RFC 9457 problem with an actionable detail.
Plans
Requires flat-files.read. Access, recency and history depth come from the plan definitions the API enforces.
| Plan | Access | Recency | History |
|---|---|---|---|
| Free | Not included | — | — |
| Developer | Not included | — | — |
| Pro | Included | Nightly files | 15 years |
| Commercial | Included | Nightly files | Full history |
| Scale | Included | Nightly files | Full history |
History is how far back a plan may request. How far records actually go for a symbol is history_from in dataset coverage. Nothing is real-time. Compare plans