polkadex

API Reference

The Query type in GraphQL represents the entry point for retrieving data from the API. It defines the available read-only operations (queries) that clients can execute to fetch data.

Query

findBalanceByMainAccount

findOrderById

findUserByMainAccount

findUserByTradeAccount

getAllAssets

getAllBalancesByMainAccount

getAllMarkets

getKlinesByMarketInterval

getMarketTickers

getOrderbook

listOpenOrdersByMainAccount

listOpenOrdersByTradeAccount

listOrderHistoryByMainAccount

listOrderHistoryByTradeAccount

listRecentTrades

listTradesByMainAccount

listTradesByMarket

listTradesByTradeAccount

listTransactionsByMainAccount

The Mutation type in GraphQL is used for modifying or creating data. It defines the operations (mutations) that allow clients to make changes to the data stored on the server, such as creating, updating, or deleting resources

Mutation

cancel_all

cancel_order

place_order

publish

withdraw

The Subscription type in GraphQL enables real-time communication between clients and the server. It defines a set of events or data streams that clients can subscribe to and receive updates whenever the subscribed events occur.

Subscription

websocket_streams

Objects in GraphQL represent complex data structures. They define the fields and their types that can be queried in a GraphQL API. Objects can have nested fields and relationships with other objects.

Objects

Account

AccountConnection

Asset

AssetsConnection

Balance

BalanceConnection

CandleStick

Channel

KlinesConnection

Market

MarketsConnection

Order

Orderbook

OrdersConnection

PriceLevel

TickersConnection

TickerStats

Trade

TradesConnection

Transaction

TransactionsConnection

UserActionInput

UserTrade

UserTradesConnection

Scalars: Scalars in GraphQL represent primitive data types, such as String, Int, Boolean, Float, etc. They are used to define the types of individual fields in the GraphQL schema.

Scalars

Represents a boolean value that can be either true or false.

Boolean

A signed double-precision floating-point value.

Float

A unique identifier, often used to refetch an object or as a key for caching.

String

Directives in GraphQL provide a way to control the execution behavior of queries and mutations. They allow you to modify the result, change the execution order, skip or include fields conditionally, and apply custom logic to the resolution process.

Directives

Enums in GraphQL define a set of possible values for a field. They represent a discrete set of options or states that a field can have. Enums help ensure type safety and provide a clear list of valid values for a field.

Enums

OrderSide

OrderStatus

OrderType

TransactionStatus

TransactionType

Unions in GraphQL allow you to combine multiple object types into a single type. They represent a result that can be one of several object types. Unions are useful when a field can return different types of objects, and you want to specify all the possible types in the schema.

Unions

GraphQL API Specification

Orderbook Api Docs

Production

Sandbox

The Query type in GraphQL represents the entry point for retrieving data from the API. It defines the available read-only operations (queries) that clients can execute to fetch data.

The Mutation type in GraphQL is used for modifying or creating data. It defines the operations (mutations) that allow clients to make changes to the data stored on the server, such as creating, updating, or deleting resources

main

proxy

stid

items

nextToken

symbol

name

asset_id

data

market

Maximum volume allowed for placing an order for curret market

max_volume

Minimum volume allowed for placing an order for curret market

min_volume

price_tick_size

qty_step_size

base_asset_precision

quote_asset_precision

Trading account address which is used for placing order

Client Order ID. It's an order id that clients like bots can add into the payload to track orders

Status of order i.e OPEN or CANCELLED or CLOSED

Amount/Quantity for which order is placed

Flag for checking if order is reverted or not

isReverted

taker_id

maker_id

trade_id

Flag for checking if trade is reverted or not

snapshot_id

Flag for checking if transaction is reverted or not

Sections