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
| Operation | Method | Planned route |
|---|---|---|
| Snapshot | GET | /api/snapshotPublicSnapshotEverything |
| Live stream | GET | /api/streamPublicLive |
| Markets | GET | /api/marketsPublicMarketsEach |
| Candles | GET | /api/candlesPublicCandlesOHLC |
| Funding | GET | /api/fundingPublicFundingThe |
| Oracle health | GET | /api/oraclesPublicOracle |
| History | GET | /api/historyPublicHistoryStored |
| Health | GET | /api/healthPublicHealthThe |
Accounts
| Operation | Method | Planned route |
|---|---|---|
| Account | GET | /api/accountPublicAccountOne |
| Orders | GET | /api/ordersPublicOrdersThe |
| Stops and targets | GET | /api/positions/triggersPublicStops |
| Order nonce | GET | /api/noncePublicOrder |
| CSV export | GET | /api/account/exportPublicCSV |
Sessions
| Operation | Method | Planned route |
|---|---|---|
| Epoch, or whether a key is live | GET | /api/sessionPublicEpoch |
| Open a session | POST | /api/session |
| Revoke a session | DELETE | /api/session |
Trading
| Operation | Method | Planned route |
|---|---|---|
| Place an order | POST | /api/orders |
| Cancel an order | POST | /api/orders/cancel |
| Close a position | POST | /api/positions/close |
| Partial close | POST | /api/positions/reduce |
| Add margin | POST | /api/positions/margin |
| Stop-loss or take-profit | POST | /api/positions/triggers |
| Cancel a stop or target | POST | /api/positions/triggers/cancel |
| Deposit or withdraw test collateral | POST | /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
