Flat Files (Labs)
Flat Files have been released as a CM Labs project. Breaking changes may be introduced with minimal notice. Please exercise caution given the endpoint's experimental nature.
Flat Files Overview
Our datasets are available via our Flat Files Console. This enables users to download a file for a specific data type for a specific exchange for a specific day. Many users prefer this rather than downloading large amounts of historical data via API.
The flat file application currently supports trades, market candles and quotes from all of our spot and futures markets. Flat file datasets for a given day are available on the next day around 05:00 UTC.
API Keys are not provisioned by default to access the application. If you are interested in accessing our flat files please reach out to the Customer Success Team. Also, please note this delivery system is a Labs product.
Login Methods
Paste your API key in Username field. Password field can be blank.
Pass the 'api_key' query parameter (e.g. https://files.coinmetrics.io/?api_key=XXX)
Navigation
For candles and trades, the navigation is always data type --> exchange --> [file for each date]. However, for quotes some data is also split by instrument.
JSON API
To access the folders available to your API Key enter this in your browser: https://files.coinmetrics.io/api/?api_key=XXX
Then you can traverse to any specific folder and see it's contents by adding the folder name to the URL: https://files.coinmetrics.io/api/market-candles-future-10m/?api_key=XXX
To traverse into the exchange folder you desire, add the exchange name: https://files.coinmetrics.io/api/market-candles-future-10m/bitmex/?api_key=XXX
Python Access
There is also an example in the client api area which shows a way to get the files with our API Client: https://github.com/coinmetrics/api-client-python/blob/master/examples/files_download/trades_files_exporter.py
Last updated