Polygon.io Crypto API

Aggregates, trades, snapshots, level-2 books, and L2 streaming for crypto pairs across major exchanges.

Documentation Provider Profile APIs.io AsyncAPI GitHub

Polygon.io Crypto API is one of 8 APIs that Polygon.io publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Crypto, Cryptocurrency, and Market Data. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.

This event API exposes 39 operations across 38 channels, and defines 60 schemas. It is described by AsyncAPI 2.6.0, at version 2.0.0.

The API connects through 14 servers: socket.polygon.io/stocks (wss), delayed.polygon.io/stocks (wss), socket.polygon.io/options (wss), delayed.polygon.io/options (wss), socket.polygon.io/forex (wss), socket.polygon.io/crypto (wss), socket.polygon.io/indices (wss), socket.polygon.io/futures (wss), launchpad.polygon.io (wss), business.polygon.io (wss), nasdaqfeed.polygon.io/stocks (wss), polyfeed.polygon.io/stocks (wss), polyfeedplus.polygon.io/stocks (wss), starterfeed.polygon.io/stocks (wss).

39 operations 38 channels 60 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification

AsyncAPI 2.6.0

API Version

2.0.0

Base URL

https://api.polygon.io

Contact

Polygon.io Developer Support

License

Polygon.io Terms of Service

Resource Areas

Channels & Operations 39

Across 38 channels, the API surfaces 39 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 39

SUB

stocks/T

Receive real-time stock trade events.

subscribeStocksTrades 1 param body

SUB

stocks/Q

Receive real-time stock quote (NBBO) events.

subscribeStocksQuotes body

SUB

stocks/A

Receive per-second stock aggregate (OHLCV) events.

subscribeStocksSecAggregates body

SUB

stocks/AM

Receive per-minute stock aggregate (OHLCV) events.

subscribeStocksMinAggregates body

SUB

stocks/LULD

Receive LULD (price band) events.

subscribeStocksLULD body

SUB

stocks/NOI

Receive auction imbalance events.

subscribeStocksImbalances body

SUB

business/stocks/FMV

Receive Fair Market Value events for stocks.

subscribeStocksFMV body

SUB

launchpad/stocks/AM

Receive per-minute stock aggregates over Launchpad.

subscribeLaunchpadStocksMinAggregates body

SUB

launchpad/stocks/LV

Receive Launchpad Value events for stocks.

subscribeLaunchpadStocksValue body

SUB

options/T

Receive real-time option trade events.

subscribeOptionsTrades body

SUB

options/Q

Receive real-time option quote events.

subscribeOptionsQuotes body

SUB

options/A

Receive per-second option aggregate events.

subscribeOptionsSecAggregates body

SUB

options/AM

Receive per-minute option aggregate events.

subscribeOptionsMinAggregates body

SUB

business/options/FMV

Receive Fair Market Value events for options.

subscribeOptionsFMV body

SUB

launchpad/options/AM

Receive per-minute option aggregates over Launchpad.

subscribeLaunchpadOptionsMinAggregates body

SUB

launchpad/options/LV

Receive Launchpad Value events for options.

subscribeLaunchpadOptionsValue body

SUB

forex/C

Receive real-time forex quote events.

subscribeForexQuotes body

SUB

forex/CA

Receive per-minute forex aggregate events.

subscribeForexMinAggregates body

SUB

forex/CAS

Receive per-second forex aggregate events.

subscribeForexSecAggregates body

SUB

business/forex/FMV

Receive Fair Market Value events for forex.

subscribeForexFMV body

SUB

launchpad/forex/AM

Receive per-minute forex aggregates over Launchpad.

subscribeLaunchpadForexMinAggregates body

SUB

launchpad/forex/LV

Receive Launchpad Value events for forex.

subscribeLaunchpadForexValue body

SUB

crypto/XT

Receive real-time crypto trade events.

subscribeCryptoTrades body

SUB

crypto/XQ

Receive real-time crypto quote events.

subscribeCryptoQuotes body

SUB

crypto/XA

Receive per-minute crypto aggregate events.

subscribeCryptoMinAggregates body

SUB

crypto/XAS

Receive per-second crypto aggregate events.

subscribeCryptoSecAggregates body

SUB

crypto/XL2

Receive Level 2 order book snapshots.

subscribeCryptoLevel2 body

SUB

business/crypto/FMV

Receive Fair Market Value events for crypto.

subscribeCryptoFMV body

SUB

launchpad/crypto/AM

Receive per-minute crypto aggregates over Launchpad.

subscribeLaunchpadCryptoMinAggregates body

SUB

launchpad/crypto/LV

Receive Launchpad Value events for crypto.

subscribeLaunchpadCryptoValue body

SUB

indices/V

Receive real-time index value events.

subscribeIndicesValue body

SUB

indices/A

Receive per-second index aggregate events.

subscribeIndicesSecAggregates body

SUB

indices/AM

Receive per-minute index aggregate events.

subscribeIndicesMinAggregates body

SUB

futures/T

Receive real-time futures trade events.

subscribeFuturesTrades body

SUB

futures/Q

Receive real-time futures quote events.

subscribeFuturesQuotes body

SUB

futures/A

Receive per-second futures aggregate events.

subscribeFuturesSecAggregates body

SUB

futures/AM

Receive per-minute futures aggregate events.

subscribeFuturesMinAggregates body

SUB

control

Receive connection / auth / subscription status events.

receiveStatusMessage body

PUB

control

Send auth, subscribe, or unsubscribe control messages.

sendControlMessage body

Messages & Schemas 60

The contract defines 60 schemas that model the data carried by its messages. The most detailed are StockAggregate (15 properties), LaunchpadAggregateMinute (14 properties), OptionAggregate (14 properties), StockQuote (13 properties). Each schema is shown below with its type and property counts.

AuthMessage

message

Authenticate the WebSocket session with an API key.

SubscribeMessage

message

Subscribe to one or more topics.

UnsubscribeMessage

message

Unsubscribe from one or more topics.

StatusMessage

message

Server-side status update for connect, auth, subscribe, and unsubscribe operations.

StockTrade

message

A single stock trade tick from the SIP or a TRF.

StockQuote

message

A single stock NBBO quote update.

StockAggregate

message

Aggregated OHLCV window covering one second.

StockAggregateMinute

message

Aggregated OHLCV window covering one minute.

LimitUpLimitDown

message

National price bands published under Reg NMS LULD.

Imbalance

message

NYSE / Nasdaq opening or closing auction imbalance event.

FairMarketValue

message

Polygon's proprietary fair value estimate for the asset.

LaunchpadAggregateMinute

message

Per-minute aggregate routed via the Launchpad multi-market feed.

LaunchpadValue

message

Launchpad-feed value event.

OptionTrade

message

A single OPRA-licensed option trade tick.

OptionQuote

message

A single OPRA-licensed option quote update.

OptionAggregate

message

OptionAggregateMinute

message

ForexQuote

message

Currency pair quote update.

ForexAggregateMinute

message

ForexAggregateSecond

message

CryptoTrade

message

CryptoQuote

message

CryptoAggregateMinute

message

CryptoAggregateSecond

message

CryptoLevel2Book

message

Aggregated Level 2 book snapshot for a crypto pair.

IndexValue

message

IndexAggregate

message

IndexAggregateMinute

message

FuturesTrade

message

FuturesQuote

message

FuturesAggregate

message

FuturesAggregateMinute

message

StockTrade

object

12 properties

StockQuote

object

13 properties

StockAggregate

object

15 properties

StockAggregateMinute

object

LimitUpLimitDown

object

8 properties

Imbalance

object

10 properties

FairMarketValue

object

4 properties

LaunchpadAggregateMinute

object

14 properties

LaunchpadValue

object

4 properties

OptionTrade

object

8 properties

OptionQuote

object

10 properties

OptionAggregate

object

14 properties

OptionAggregateMinute

object

ForexQuote

object

6 properties

ForexAggregateMinute

object

9 properties

ForexAggregateSecond

object

9 properties

CryptoTrade

object

9 properties

CryptoQuote

object

9 properties

CryptoAggregateMinute

object

11 properties

CryptoAggregateSecond

object

11 properties

CryptoLevel2Book

object

7 properties

IndexValue

object

4 properties

IndexAggregate

object

9 properties

IndexAggregateMinute

object

FuturesTrade

object

6 properties

FuturesQuote

object

9 properties

FuturesAggregate

object

11 properties

FuturesAggregateMinute

object

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

Other APIs Polygon.io publishes across the network.

Polygon.io Stocks API

AE Profile APIs.io

Polygon.io Options API

AE Profile APIs.io

Polygon.io Indices API

AE Profile APIs.io

Polygon.io Forex API

AE Profile APIs.io

Polygon.io Futures API

AE Profile APIs.io

Polygon.io Aggregates API

AE Profile APIs.io

Polygon.io Reference API

AE Profile APIs.io

#Crypto#Cryptocurrency#Market Data

← Back to P APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Polygon.io Crypto API

Metadata

Channels & Operations 39

Messages & Schemas 60

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Polygon.io Crypto API

Metadata

Channels & Operations 39

Messages & Schemas 60

Specification

Source

More from Polygon.io 7

API Details

Provider

Explore more