Welcome to the PLATONEX | Bitcoin & Cryptocurrency Exchange REST API documentation. This API (Application Programming Interface) will allow you to access the functionality of this exchange by means of HTTP requests, making integration with your own applications possible.

Public Endpoints

URL for API access: https://platonex.io/api/public/v1/{endpoint}?{params}

‘endpoint’ - Endpoint of API you are accessing,
‘params’ - incoming request parameters (if required)

Endpoint: asset

Description: The assets endpoint is to provide a detailed summary for each currency available on the exchange.

Request parameter(s): Not needed

https://platonex.io/api/public/v1/assets

Success response:


{
	"BTC": {
		"name": "Bitcoin",
		"id": "28",
		"can_withdraw": "1",
		"can_deposit": "1",
		"min_withdraw": "0",
		"max_withdraw": "0",
		"maker_fee": "0.25",
		"taker_fee": "0.25
	},
	"ETH": {
		"name": "Ethereum",
		"id": "45",
		"can_withdraw": "1",
		"can_deposit": "1",
		"min_withdraw": "0",
		"max_withdraw": "0",
		"maker_fee": "0.25",
		"taker_fee":"0.25"
	}
}

Response parameter(s):

Parameter	Type	Description
name	String	Name of cryptocurrency
id	String	Unique ID
can_withdraw	String	Identifies whether withdraws are enabled or disabled.
can_deposit	String	Identifies whether deposits are enabled or disabled.
min_withdraw	String	Identifies the single minimum withdraw amount of a cryptocurrency.
max_withdraw	String	Identifies the single maximum withdraw amount of a cryptocurrency. 0 - disabled
maker_fee	String	Fees applied when liquidity is added to the order book.
taker_fee	String	Fees applied when liquidity is removed from the order book.

Ratelimit 2 req/sec

Endpoint: ticker

Description: The ticker endpoint is to provide a 24-hour pricing and volume summary for each market pair available on the exchange.

Request parameter(s): Not needed

https://platonex.io/api/public/v1/ticker/

Success response:



{
    "ETH_BTC": {
        "base_id": "45",
        "quote_id":"28",
        "last_price": "0.10900100",
        "base_volume": "120.23360000",
        "quote_volume":"12.79950000",
        "isFrozen": "0",
        "low24hr": "0.10331007",
        "high24hr": "0.11000000",
        "percentChange": "0.00000000",
        "lowestAsk": "0.02099987",
        "highestBid": "0.02023951"
    },
    "OMG_ETH": {
        "base_id": "50",
        "quote_id": "45",
        "last_price": "0.01621999",
        "base_volume": "235.63020000",
        "quote_volume": "3.78740000",
        "isFrozen": "0",
        "low24hr": "0.01590011",
        "high24hr": "0.01649998",
        "percentChange": "0.00000000",
        "lowestAsk": "0.00682898",
        "highestBid": "0.00663000"
    }
}

Response parameter(s):

Parameter	Type	Description
base_id	String	The base asset unique ID.
quote_id	String	The quote asset unique ID.
last_price	String	The price of the last executed order.
base_volume	String	24 hour trading volume in base units.
quote_volume	String	24 hour trading volume in quoted units.
isFrozen	String	Indicates if the market is currently enabled (1) or disabled (0).
low24hr	String	The lowest execution price for this pair within the last 24 hours
high24hr	String	The highest execution price for this pair within the last 24 hours.
percentChange	String	Price change percentage.
lowestAsk	String	Lowest current purchase price for this asset.
highestBid	String	Highest current purchase price for this asset.

Ratelimit 2 req/sec

Endpoint: orderbook

Description: The order book endpoint is to provide a complete order book with full depth returned for a given market pair.

Request parameter(s):

Parameter	Is Required	Type	Description
market_pair	Yes	string	Must be ETH-BTC format.

https://platonex.io/api/public/v1/orderbook/index.php?market_pair=ETH-BTC

Success response:



{
    "timestamp": "1570712983",
    "asks": [
        [
            "0.02099999",
            "0.22454389"
        ],
        [
            "0.02114000",
            "0.10000000"
        ]
    ],
    "bids": [
        [
            "0.02011000",
            "0.05104000"
        ],
        [
            "0.02009993",
            "0.04798341"
        ]
    ]
}

Response parameter(s):

Parameter	Type	Description
timestamp	string	Unix timestamp in seconds for when the last updated time occurred.
asks	array	An array containing 2 elements. The ask price and quantity for each ask order.
bids	array	An array containing 2 elements. The bid price and quantity for each ask order.

Ratelimit 2 req/sec

Endpoint: trades

Description: The trades endpoint is to return data on all recently completed trades for a given market pair.

Request parameter(s):

Parameter	Is Required	Type	Description
market_pair	Yes	string	Must be ETH-BTC format.

https://platonex.io/api/public/v1/trades/index.php?market_pair=ETH-BTC

Success response:


[
    {
        "trade_id": "11536286",
        "price": "0.02023952",
        "base_volume": "0.01145925",
        "quote_volume": "0.00023192",
        "trade_timestamp": "1569591808",
        "type":"sell"
    },
    {
        "trade_id": "11536284",
        "price": "0.02024000",
        "base_volume": "0.11302150",
        "quote_volume": "0.00228755",
        "trade_timestamp": "1569591808",
        "type": "sell"
    },
    {
        "trade_id": "..."
    },
    {
        "trade_id":"11534676",
        "price": "0.02080524",
        "base_volume": "35.64549988",
        "quote_volume":"0.74161317",
        "trade_timestamp": "1569301803",
        "type": "sell"
    },
    {
        "trade_id": "11534668",
        "price": "0.02079909",
        "base_volume": "45.19564606",
        "quote_volume": "0.94002831",
        "trade_timestamp": "1569301707",
        "type": "sell"
    }
]

Response parameter(s):

Parameter	Type	Description
trade_id	string	A unique ID associated with the trade for the currency pair transaction.
price	string	Transaction price in quoted units.
base_volume	string	Transaction amount in base units.
quote_volume	string	Transaction amount in quoted units.
trade_timestamp	string	Unix timestamp in seconds for when the transaction occurred.
type	string	Used to determine whether or not the transaction originated as a buy or sell. Buy – Identifies an ask was removed from the order book. Sell – Identifies a bid was removed from the order book.

Ratelimit 2 req/sec