Pyth Lazer Router API 0.1.0 documentation

Pyth Lazer Router API 0.1.0

This service allows the consumers to fetch price updates.

Authentication

The streaming WebSocket endpoint (/v1/stream) requires authentication. The client may use either of the following methods to specify their access token:

Set Authorization header of the request to Bearer <token>.
Specify the token in a GET parameter by adding ?ACCESS_TOKEN=<token> to the request URL.

Servers

wss://pyth-lazer-staging.dourolabs.app/wsspyth lazer

Operations

SEND /v1/stream
Send a request to the server.
The schema of the Request message provided below lists the available request types.

Operation IDrequest
Available only on servers:
- pyth lazer
Accepts the following message:
Request
Message IDRequest
object anyOf
object [SubscribeRequest]
Subscribe to price updates

After a successful subscription, the server will respond with a Subscribed message, followed by StreamUpdated messages. If a subscription cannot be made, the server will respond with a SubscriptionError message containing the error message.

Examples values:
{"type":"subscribe","subscriptionId":1,"priceFeedIds":[1,2],"properties":["price"],"chains":["solana"],"deliveryFormat":"json","channel":"fixed_rate@200ms","jsonBinaryEncoding":"hex"}
type
required
string
Const:"subscribe"
subscriptionId
number
Identifier assigned to this subscription by the sender. This identifier will be sent back in any responses related to this subscription.

required
array<number>
non-empty
List of price feed IDs to subscribe to.

Items:
number
required
array<string>
non-empty
List of price feed properties the sender is interested in.

Items:
string
Allowed values:
"price"
"bestBidPrice"
"bestAskPrice"
channel
required
string
Channel to subscribe to. In the real time channel, the server will send any price updates as soon as they are available. In fixed rate channels, the updates will be sent every 50 or 200 ms, respectively.

Allowed values:
"real_time"
"fixed_rate@50ms"
"fixed_rate@200ms"
required
array<string>
List of the chains. as part of each price update, the server will send on-chain payloads required to validate these price updates on the specified chains.

Items:
string
Allowed values:
"solana"
"evm"
parsed
boolean
If true, the price updates will include a JSON representation of the contained values.

Default value:true
deliveryFormat
string
If json is selected, the server will send price updates as JSON objects (the on-chain payload will be encoded according to the jsonBinaryEncoding property). If binary is selected, the server will send price updates as binary messages.

Default value:"json"
Allowed values:
"json"
"binary"
jsonBinaryEncoding
string
For deliveryFormat == "json", the on-chain payload will be encoded using the specified encoding. This option has no effect for deliveryFormat == "binary".

Default value:"base64"
Allowed values:
"base64"
"hex"
Additional properties are NOT allowed.
object [UnsubscribeRequest]
Unsubscribe from price updates.

After a successful unsubscription, the server will respond with a Unsubscribed message and stop sending StreamUpdated messages for that subscription. If the unsubscription cannot be made, the server will respond with a SubscriptionError message containing the error message.

type
required
string
Const:"unsubscribe"
subscriptionId
required
number
The value specified in the corresponding SubscribeRequest.

Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "type": "subscribe", "subscriptionId": 1, "priceFeedIds": [ 1, 2 ], "properties": [ "price" ], "chains": [ "solana" ], "deliveryFormat": "json", "channel": "fixed_rate@200ms", "jsonBinaryEncoding": "hex" }

This example has been generated automatically.
RECEIVE /v1/stream
Receive a response from the server.
The schema of the Response message provided below lists the available response types.

Operation IDresponse
Available only on servers:
- pyth lazer
Accepts the following message:
Response
Message IDResponse
object anyOf
object [SubscribedResponse]
Notification of a successful subscription.

type
required
string
Const:"subscribed"
subscriptionId
required
number
The value specified in the corresponding SubscribeRequest.

Additional properties are allowed.
object [UnsubscribedResponse]
Notification of a successful unsubscription.

type
required
string
Const:"unsubscribed"
subscriptionId
required
number
The value specified in the corresponding SubscribeRequest.

Additional properties are allowed.
object [StreamUpdated]
Notification of a price update.

Examples values:
{"type":"streamUpdated","subscriptionId":1,"parsed":{"timestampUs":"1730986152400000","priceFeeds":[{"priceFeedId":1,"price":"1006900000000"},{"priceFeedId":2,"price":"2006900000000"}]},"solana":{"encoding":"hex","data":"b9011a82d239c094c52016990d6ca2b261dbb1157ad503cbd3ea0679493316150cf3457624d19ec3f6e0a0e94373ab0971e39d939beda15cc02eb3c5454eb700f1f7310df65210bee4fcf5b1cee1e537fabcfd95010297653b94af04d454fc473e94834f2a0075d3c7938094b99e52260600030201000000010000b5ea6fea00000002000000010000c58f44d3010000"}}
type
required
string
Const:"streamUpdated"
subscriptionId
required
number
The value specified in the corresponding SubscribeRequest.

object
Parsed representation of the price update. Only present if parsed == true was set in the SubscriptionRequest.

timestampUs
required
string
Unix timestamp associated with the update (with microsecond precision).

required
array<object>
Values of the price update.

object
priceFeedId
required
number
Price feed ID.

price
string
Main price for this price feed. Only present if price property was specified in the SubscriptionRequest and if the value is currently available for this price feed.

bestBidPrice
string
Best bid price for this price feed. Only present if bestBidPrice property was specified in the SubscriptionRequest and if the value is currently available for this price feed.

bestAskPrice
string
Best ask price for this price feed. Only present if bestAskPrice property was specified in the SubscriptionRequest and if the value is currently available for this price feed.

Additional properties are allowed.
Additional properties are allowed.
object
On-chain payload for EVM. Only present if evm chain was specified in the SubscriptionRequest.

encoding
required
string
Encoding of the data. It will be the same as jsonBinaryEncoding specified in the SubscriptionRequest.

Allowed values:
"base64"
"hex"
data
required
string
Base64- or Hex-encoded on-chain update.

Additional properties are allowed.
object
On-chain payload for Solana. Only present if solana chain was specified in the SubscriptionRequest.

encoding
required
string
Encoding of the data. It will be the same as jsonBinaryEncoding specified in the SubscriptionRequest.

Allowed values:
"base64"
"hex"
data
required
string
Base64- or Hex-encoded on-chain update.

Additional properties are allowed.
Additional properties are allowed.
object [SubscriptionError]
Notification of a failed subscription or unsubscription.

type
required
string
Const:"subscriptionError"
subscriptionId
required
number
The value specified in the corresponding SubscribeRequest.

error
required
string
The error message.

Additional properties are allowed.
object [Error]
Notification of a general error.

type
required
string
Const:"error"
error
required
string
The error message.

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "subscribed", "subscriptionId": 0 }

This example has been generated automatically.

Schemas

object anyOf
object [SubscribeRequest]
Subscribe to price updates

After a successful subscription, the server will respond with a Subscribed message, followed by StreamUpdated messages. If a subscription cannot be made, the server will respond with a SubscriptionError message containing the error message.

Examples values:
{"type":"subscribe","subscriptionId":1,"priceFeedIds":[1,2],"properties":["price"],"chains":["solana"],"deliveryFormat":"json","channel":"fixed_rate@200ms","jsonBinaryEncoding":"hex"}
type
required
string
Const:"subscribe"
subscriptionId
number
Identifier assigned to this subscription by the sender. This identifier will be sent back in any responses related to this subscription.

required
array<number>
non-empty
List of price feed IDs to subscribe to.

Items:
number
required
array<string>
non-empty
List of price feed properties the sender is interested in.

Items:
string
Allowed values:
"price"
"bestBidPrice"
"bestAskPrice"
channel
required
string
Channel to subscribe to. In the real time channel, the server will send any price updates as soon as they are available. In fixed rate channels, the updates will be sent every 50 or 200 ms, respectively.

Allowed values:
"real_time"
"fixed_rate@50ms"
"fixed_rate@200ms"
required
array<string>
List of the chains. as part of each price update, the server will send on-chain payloads required to validate these price updates on the specified chains.

Items:
string
Allowed values:
"solana"
"evm"
parsed
boolean
If true, the price updates will include a JSON representation of the contained values.

Default value:true
deliveryFormat
string
If json is selected, the server will send price updates as JSON objects (the on-chain payload will be encoded according to the jsonBinaryEncoding property). If binary is selected, the server will send price updates as binary messages.

Default value:"json"
Allowed values:
"json"
"binary"
jsonBinaryEncoding
string
For deliveryFormat == "json", the on-chain payload will be encoded using the specified encoding. This option has no effect for deliveryFormat == "binary".

Default value:"base64"
Allowed values:
"base64"
"hex"
Additional properties are NOT allowed.
object [UnsubscribeRequest]
Unsubscribe from price updates.

After a successful unsubscription, the server will respond with a Unsubscribed message and stop sending StreamUpdated messages for that subscription. If the unsubscription cannot be made, the server will respond with a SubscriptionError message containing the error message.

type
required
string
Const:"unsubscribe"
subscriptionId
required
number
The value specified in the corresponding SubscribeRequest.

Additional properties are NOT allowed.
Additional properties are NOT allowed.
object [SubscribeRequest]
Subscribe to price updates

After a successful subscription, the server will respond with a Subscribed message, followed by StreamUpdated messages. If a subscription cannot be made, the server will respond with a SubscriptionError message containing the error message.

Examples values:
{"type":"subscribe","subscriptionId":1,"priceFeedIds":[1,2],"properties":["price"],"chains":["solana"],"deliveryFormat":"json","channel":"fixed_rate@200ms","jsonBinaryEncoding":"hex"}
type
required
string
Const:"subscribe"
subscriptionId
number
Identifier assigned to this subscription by the sender. This identifier will be sent back in any responses related to this subscription.

required
array<number>
non-empty
List of price feed IDs to subscribe to.

Items:
number
required
array<string>
non-empty
List of price feed properties the sender is interested in.

Items:
string
Allowed values:
"price"
"bestBidPrice"
"bestAskPrice"
channel
required
string
Channel to subscribe to. In the real time channel, the server will send any price updates as soon as they are available. In fixed rate channels, the updates will be sent every 50 or 200 ms, respectively.

Allowed values:
"real_time"
"fixed_rate@50ms"
"fixed_rate@200ms"
required
array<string>
List of the chains. as part of each price update, the server will send on-chain payloads required to validate these price updates on the specified chains.

Items:
string
Allowed values:
"solana"
"evm"
parsed
boolean
If true, the price updates will include a JSON representation of the contained values.

Default value:true
deliveryFormat
string
If json is selected, the server will send price updates as JSON objects (the on-chain payload will be encoded according to the jsonBinaryEncoding property). If binary is selected, the server will send price updates as binary messages.

Default value:"json"
Allowed values:
"json"
"binary"
jsonBinaryEncoding
string
For deliveryFormat == "json", the on-chain payload will be encoded using the specified encoding. This option has no effect for deliveryFormat == "binary".

Default value:"base64"
Allowed values:
"base64"
"hex"
Additional properties are NOT allowed.
object [UnsubscribeRequest]
Unsubscribe from price updates.

After a successful unsubscription, the server will respond with a Unsubscribed message and stop sending StreamUpdated messages for that subscription. If the unsubscription cannot be made, the server will respond with a SubscriptionError message containing the error message.

type
required
string
Const:"unsubscribe"
subscriptionId
required
number
The value specified in the corresponding SubscribeRequest.

Additional properties are NOT allowed.
object anyOf
object [SubscribedResponse]
Notification of a successful subscription.

type
required
string
Const:"subscribed"
subscriptionId
required
number
The value specified in the corresponding SubscribeRequest.

Additional properties are allowed.
object [UnsubscribedResponse]
Notification of a successful unsubscription.

type
required
string
Const:"unsubscribed"
subscriptionId
required
number
The value specified in the corresponding SubscribeRequest.

Additional properties are allowed.
object [StreamUpdated]
Notification of a price update.

Examples values:
{"type":"streamUpdated","subscriptionId":1,"parsed":{"timestampUs":"1730986152400000","priceFeeds":[{"priceFeedId":1,"price":"1006900000000"},{"priceFeedId":2,"price":"2006900000000"}]},"solana":{"encoding":"hex","data":"b9011a82d239c094c52016990d6ca2b261dbb1157ad503cbd3ea0679493316150cf3457624d19ec3f6e0a0e94373ab0971e39d939beda15cc02eb3c5454eb700f1f7310df65210bee4fcf5b1cee1e537fabcfd95010297653b94af04d454fc473e94834f2a0075d3c7938094b99e52260600030201000000010000b5ea6fea00000002000000010000c58f44d3010000"}}
type
required
string
Const:"streamUpdated"
subscriptionId
required
number
The value specified in the corresponding SubscribeRequest.

object
Parsed representation of the price update. Only present if parsed == true was set in the SubscriptionRequest.

timestampUs
required
string
Unix timestamp associated with the update (with microsecond precision).

required
array<object>
Values of the price update.

object
priceFeedId
required
number
Price feed ID.

price
string
Main price for this price feed. Only present if price property was specified in the SubscriptionRequest and if the value is currently available for this price feed.

bestBidPrice
string
Best bid price for this price feed. Only present if bestBidPrice property was specified in the SubscriptionRequest and if the value is currently available for this price feed.

bestAskPrice
string
Best ask price for this price feed. Only present if bestAskPrice property was specified in the SubscriptionRequest and if the value is currently available for this price feed.

Additional properties are allowed.
Additional properties are allowed.
object
On-chain payload for EVM. Only present if evm chain was specified in the SubscriptionRequest.

encoding
required
string
Encoding of the data. It will be the same as jsonBinaryEncoding specified in the SubscriptionRequest.

Allowed values:
"base64"
"hex"
data
required
string
Base64- or Hex-encoded on-chain update.

Additional properties are allowed.
object
On-chain payload for Solana. Only present if solana chain was specified in the SubscriptionRequest.

encoding
required
string
Encoding of the data. It will be the same as jsonBinaryEncoding specified in the SubscriptionRequest.

Allowed values:
"base64"
"hex"
data
required
string
Base64- or Hex-encoded on-chain update.

Additional properties are allowed.
Additional properties are allowed.
object [SubscriptionError]
Notification of a failed subscription or unsubscription.

type
required
string
Const:"subscriptionError"
subscriptionId
required
number
The value specified in the corresponding SubscribeRequest.

error
required
string
The error message.

Additional properties are allowed.
object [Error]
Notification of a general error.

type
required
string
Const:"error"
error
required
string
The error message.

Additional properties are allowed.
Additional properties are allowed.
object [SubscribedResponse]
Notification of a successful subscription.

type
required
string
Const:"subscribed"
subscriptionId
required
number
The value specified in the corresponding SubscribeRequest.

Additional properties are allowed.
object [UnsubscribedResponse]
Notification of a successful unsubscription.

type
required
string
Const:"unsubscribed"
subscriptionId
required
number
The value specified in the corresponding SubscribeRequest.

Additional properties are allowed.
object [StreamUpdated]
Notification of a price update.

Examples values:
{"type":"streamUpdated","subscriptionId":1,"parsed":{"timestampUs":"1730986152400000","priceFeeds":[{"priceFeedId":1,"price":"1006900000000"},{"priceFeedId":2,"price":"2006900000000"}]},"solana":{"encoding":"hex","data":"b9011a82d239c094c52016990d6ca2b261dbb1157ad503cbd3ea0679493316150cf3457624d19ec3f6e0a0e94373ab0971e39d939beda15cc02eb3c5454eb700f1f7310df65210bee4fcf5b1cee1e537fabcfd95010297653b94af04d454fc473e94834f2a0075d3c7938094b99e52260600030201000000010000b5ea6fea00000002000000010000c58f44d3010000"}}
type
required
string
Const:"streamUpdated"
subscriptionId
required
number
The value specified in the corresponding SubscribeRequest.

object
Parsed representation of the price update. Only present if parsed == true was set in the SubscriptionRequest.

timestampUs
required
string
Unix timestamp associated with the update (with microsecond precision).

required
array<object>
Values of the price update.

object
priceFeedId
required
number
Price feed ID.

price
string
Main price for this price feed. Only present if price property was specified in the SubscriptionRequest and if the value is currently available for this price feed.

bestBidPrice
string
Best bid price for this price feed. Only present if bestBidPrice property was specified in the SubscriptionRequest and if the value is currently available for this price feed.

bestAskPrice
string
Best ask price for this price feed. Only present if bestAskPrice property was specified in the SubscriptionRequest and if the value is currently available for this price feed.

Additional properties are allowed.
Additional properties are allowed.
object
On-chain payload for EVM. Only present if evm chain was specified in the SubscriptionRequest.

encoding
required
string
Encoding of the data. It will be the same as jsonBinaryEncoding specified in the SubscriptionRequest.

Allowed values:
"base64"
"hex"
data
required
string
Base64- or Hex-encoded on-chain update.

Additional properties are allowed.
object
On-chain payload for Solana. Only present if solana chain was specified in the SubscriptionRequest.

encoding
required
string
Encoding of the data. It will be the same as jsonBinaryEncoding specified in the SubscriptionRequest.

Allowed values:
"base64"
"hex"
data
required
string
Base64- or Hex-encoded on-chain update.

Additional properties are allowed.
Additional properties are allowed.
object [SubscriptionError]
Notification of a failed subscription or unsubscription.

type
required
string
Const:"subscriptionError"
subscriptionId
required
number
The value specified in the corresponding SubscribeRequest.

error
required
string
The error message.

Additional properties are allowed.
object [Error]
Notification of a general error.

type
required
string
Const:"error"
error
required
string
The error message.

Additional properties are allowed.

Pyth Lazer Router API 0.1.0

Authentication

Servers

Operations

SEND /v1/stream

Examples

This example has been generated automatically.

RECEIVE /v1/stream

Examples

This example has been generated automatically.

Schemas