Menu

API and SDKs

Market data, accounts, scoped sessions and order operations — organised into the same integration sections as the reference model.

Integration specification · PUSHIN does not currently publish a server API or installable SDK packages.

Download the SDKs

  • Python
  • TypeScript
  • Rust

The client-language sections are reserved for a future public API release. No package download is available yet.

Install

  • Client packages

Quickstart

  • Read a market snapshot

The current page exposes a read-only local preview. In the browser console:

window.PushinMarketPreview.snapshot("c-vix-30d")
// Generated practice data; no server request.

Conventions

  • Market identifiers
  • Precision and timestamps
  • Signatures and errors

Markets: c-vix-30d, fr-basis-btc, fr-basis-eth. Funding is expressed in basis points per eight hours. Session permissions must never include arbitrary transfers.

Signed structs

  • Session grants
  • Orders
  • Cancellations
  • Collateral moves

Market data

OperationMethodPlanned route
SnapshotGET/api/snapshotPublicSnapshotEverything
Live streamGET/api/streamPublicLive
MarketsGET/api/marketsPublicMarketsEach
CandlesGET/api/candlesPublicCandlesOHLC
FundingGET/api/fundingPublicFundingThe
Oracle healthGET/api/oraclesPublicOracle
HistoryGET/api/historyPublicHistoryStored
HealthGET/api/healthPublicHealthThe

Accounts

OperationMethodPlanned route
AccountGET/api/accountPublicAccountOne
OrdersGET/api/ordersPublicOrdersThe
Stops and targetsGET/api/positions/triggersPublicStops
Order nonceGET/api/noncePublicOrder
CSV exportGET/api/account/exportPublicCSV

Sessions

OperationMethodPlanned route
Epoch, or whether a key is liveGET/api/sessionPublicEpoch
Open a sessionPOST/api/session
Revoke a sessionDELETE/api/session

Trading

OperationMethodPlanned route
Place an orderPOST/api/orders
Cancel an orderPOST/api/orders/cancel
Close a positionPOST/api/positions/close
Partial closePOST/api/positions/reduce
Add marginPOST/api/positions/margin
Stop-loss or take-profitPOST/api/positions/triggers
Cancel a stop or targetPOST/api/positions/triggers/cancel
Deposit or withdraw test collateralPOST/api/account/collateral

The current terminal supports local market and limit orders, cancellation and full closes. The remaining operations require further implementation.

Errors

  • Validation
  • Unauthorised session
  • Insufficient collateral
  • Stale oracle
  • Rate limit