Phemex

Phemex historical market data details - available instruments, data coverage and data collection specifics

Phemex historical data for all its derivative instruments is available since 2020-03-17 (for spot markets since 2020-06-04).

https://api.tardis.dev/v1/exchanges/phemexapi.tardis.dev

See Phemex historical data coverage: available symbols, channels, date ranges and incidents

Downloadable CSV files

Historical CSV datasets for the first day of each month are available to download without API key. See downloadable CSV files documentation.

data type	symbol	date
incremental_book_L2	BTCUSD	2020-04-01	Download sample
trades	BTCUSD	2020-04-01	Download sample
derivative_ticker	BTCUSD	2020-04-01	Download sample

API Access and data format

Historical data format is the same as provided by real-time Phemex WebSocket API with addition of local timestamps. If you'd like to work with normalized data format instead (same format for each exchange) see downloadable CSV files or official client libs that can perform data normalization client-side.

Python

# pip install tardis-dev
import asyncio
from tardis_dev import Channel, replay

async def main():
    async for local_timestamp, message in replay(
        exchange="phemex",
        from_date="2024-01-01",
        to_date="2024-01-02",
        filters=[Channel(name="book", symbols=["BTCUSD"])],
        api_key="YOUR_API_KEY",
    ):
        # messages as provided by Phemex real-time stream
        print(message)

asyncio.run(main())

See Python client docs.

Node.js

// npm install tardis-dev
import { replay } from 'tardis-dev';

const messages = replay({
  exchange: 'phemex',
  from: '2024-01-01',
  to: '2024-01-02',
  filters: [{ channel: 'book', symbols: ['BTCUSD'] }],
  apiKey: 'YOUR_API_KEY'
});

// messages as provided by Phemex real-time stream
for await (const { localTimestamp, message } of messages) {
  console.log(localTimestamp, message);
}

See Node.js client docs.

cURL & HTTP API

curl --compressed -g 'https://api.tardis.dev/v1/data-feeds/phemex?from=2024-01-01&filters=[{"channel":"book","symbols":["BTCUSD"]}]&offset=0'

https://api.tardis.dev/v1/data-feeds/phemex?from=2024-01-01&filters=[{%22channel%22:%22book%22,%22symbols%22:[%22BTCUSD%22]}]&offset=0api.tardis.dev

Example API response for Phemex historical market data request

See HTTP API docs.

cURL & tardis-machine

curl -g 'localhost:8000/replay?options={"exchange":"phemex","filters":[{"channel":"book","symbols":["BTCUSD"]}],"from":"2024-01-01","to":"2024-01-02"}'

Tardis-machine is a locally runnable server that exposes API allowing efficiently requesting historical market data for whole time periods in contrast to HTTP API that provides data only in minute by minute slices.

See tardis-machine docs.

Captured real-time channels

GitHub - phemex/phemex-api-docs: Phemex Exchange Public API Reference DocumentGitHub

See Phemex WebSocket API docs providing documentation for each captured channel's format

Click any channel below to see HTTP API response with historical data recorded for it.

• trades Public trade executions stream

• trades_p — available since 2022-11-23 Public perpetual trade executions stream

• book Order book snapshots and incremental updates

• orderbook_p — available since 2022-11-23 Perpetual order book snapshots and incremental updates

• market24h 24h market statistics updates

• perp_market24h_pack_p — available since 2022-11-23 Perpetual 24h market statistics batch updates

• spot_market24h — available since 2020-06-04 Spot 24h market statistics updates

Market data collection details

Market data collection infrastructure for Phemex since 2020-06-04 is located in GCP asia-northeast1 (Tokyo, Japan), before that it was located in GCP europe-west2 region (London, UK).

Real-time market data is captured via multiple WebSocket connections to wss://vapi.phemex.com/ws.

Phemex servers are located in AWS ap-southeast-1 region (Singapore, Asia Pacific).