General

Introduction

Welcome to Crypxie API documentation. These documents outline the exchange functionality, market details, and APIs.

Get Started

API Endpoint

v1 => https://crypxie.com/api/v1/
v2 => https://crypxie.com/api/v2/

This API reference includes technical documentation needed to formulate/standardize exchange API endpoints.

Market Data

V1

This url endpoint to access v1 api :
https://crypxie.com/api/v1

Get Pairs

Result example :

{
    "result": [
        {
            "ticker_id": "BTC_ETH",
            "base": "BTC",
            "target": "ETH"
        },
        {
            "ticker_id": "BTC_USDT",
            "base": "BTC",
            "target": "USDT"
        },
        {
            "ticker_id": "BTC_DOGE",
            "base": "BTC",
            "target": "DOGE"
        },
        {
            "ticker_id": "BTC_USDC",
            "base": "BTC",
            "target": "USDC"
        }
    ],
    "error": false
}

Request via this endpoint to get trading pairs available on the exchange

HTTP REQUEST

GET /api/v1/pairs

Example

GET /api/v1/pairs

RESPONSES

Field	Description
ticker_id	Name of trading pairs
base	Base currency,e.g. BTC
target	Target currency,e.g. ETH

Get Ticker

Result example :

{
    "result": [
        {
            "ticker_id": "BTC_ETH",
            "base_currency": "BTC",
            "target_currency": "ETH",
            "last_price": "0.03423297",
            "base_volume": 0.00741283,
            "target_volume": 0.00025583,
            "bid": "0.03412255",
            "ask": "0.03436533",
            "high": 0.03491560,
            "low": 0.03412255
        },
        {
            "ticker_id": "DOGE_TRX",
            "base_currency": "DOGE",
            "target_currency": "TRX",
            "last_price": "10.49000000",
            "base_volume": 449.00000000,
            "target_volume": 43.00000000,
            "bid": "10.49000000",
            "ask": 10.3500000000,
            "high": 10.49000000,
            "low": 10.40000000
        }
    ],
    "error": false
}

Request via this endpoint to get 24-hour pricing and volume information on each market pair available on an exchange. The returned value includes the best bid price and size, the best ask price and size as well as the last traded price and the last traded size.

HTTP REQUEST

GET /api/v1/tickers

Example

GET /api/v1/tickers

RESPONSES

Field	Description
ticker_id	Name of trading pairs
base_currency	Base currency,e.g. BTC
target_currency	Target currency,e.g. ETH
last_price	Last traded price
base_volume	Base volume 24h
target_volume	Target volume 24h
bid	Best bid price
ask	Best ask price
high	Highest price 24h
low	Lowest price 24h

Get Order Book

Result example :

{
    "result": {
        "ticker_id": "BTC_ETH",
        "timestamp": 1600961666,
        "bids": [
            [
                "0.03412255",
                "0.00921000"
            ],
            [
                "0.03411205",
                "0.01120000"
            ]
        ],
        "asks": [
            [
                "0.03436533",
                "0.00407223"
            ],
            [
                "0.03482600",
                "0.00540000"
            ]
        ]
    },
    "success": true
}

Request via this endpoint to provide order book information. The returned value includes ask and size, bid and size.

HTTP REQUEST

GET /api/v1/orderbook

Example

GET /api/v1/orderbook?ticker_id=BTC_ETH

GET /api/v1/orderbook?ticker_id=BTC_ETH&depth;=2

PARAMETERS

Param	Type	Description
ticker_id	String	Ticker e.g "BTC_ETH"
depth	Integer	(optional) Orders depth quantity: [0, 2, 4, 6, ...]. 0 returns full depth. Depth = 2 means 1 for each bid / ask side. Depth = 4 means 2 for each bid / ask side. and so on multiples of 2.

RESPONSES

Field	Description
ticker_id	Ticker e.g "BTC_ETH"
timestamp	Timestamp
bids	bid list (price, size)
asks	ask list (price, size)

Get Trade Histories

Result example :

{
    "result": {
        "buy": [
            {
                "trade_id": 607,
                "price": "0.03423297",
                "base_volume": 0.45677725,
                "target_volume": "0.01025437",
                "trade_timestamp": 1600961666,
                "type": "buy"
            },
            {
                "trade_id": 605,
                "price": "0.03423297",
                "base_volume": 0.025437256,
                "target_volume": "0.01367250",
                "trade_timestamp": 1600961549,
                "type": "buy"
            }
        ]
    },
    "success": true
}

Request via this endpoint to get data on historical completed trades for a given market pair.

HTTP REQUEST

GET /api/v1/historical_trades

Example

GET /api/v1/historical_trades?ticker_id=BTC_ETH&type;=buy&limit;=3

PARAMETERS

Param	Type	Description
ticker_id	String	Ticker e.g. "BTC_ETH"
type	String	"buy" or "sell"
limit	Integer	Number of historical trades to retrieve from time of query. [0, 1, 2, 3,...]. 0 returns full history
start_time	Time	Timestamp
end_time	Time	Timestamp

RESPONSES

Field	Description
trade_id	Trade identity
price	Price
base_volume	Base volume
target_volume	Target volume
trade_timestamp	Timestamp
type	"buy" or "sell"

V2

This url endpoint to access v2 api :
https://crypxie.com/api/v2

Get Ticker

Result example :

{
    "BTC_ETH": {
        "base_id": 80,
        "quote_id": 79,
        "last_price": "0.03423297",
        "quote_volume": 0.00011627,
        "base_volume": 0.00011627,
        "isFrozen": 1
    },
    "BTC_USDT": {
        "base_id": 80,
        "quote_id": 78,
        "last_price": "0.00011627",
        "quote_volume": 0.00011627,
        "base_volume": 0.00011627,
        "isFrozen": 1
    }

Request via this endpoint to provide a 24-hour pricing and volume summary for each market pair available on the exchange.

HTTP REQUEST

GET /api/v2/ticker

Example

GET /api/v2/ticker

RESPONSES

Field	Description
base_id	Base pair identity
quote_id	Quote pair identity
last_price	Last price
quote_volume	Quote pair volume
base_volume	Base pair volume
isFrozen	"0" Frozen, "1" Not frozen

Get Order Book

Result example :

{
    "timestamp": 1600961666,
    "bids": [
        [
            "0.03412255",
            "0.00921000"
        ],
        [
            "0.03411205",
            "0.01120000"
        ]
    ],
    "asks": [
        [
            "0.03436533",
            "0.00407223"
        ],
        [
            "0.03482600",
            "0.00540000"
        ]
    ]
}

Request via this endpoint to provide a complete order book (arranged by best asks/bids) with full depth returned for a given market pair

HTTP REQUEST

GET /api/v2/orderbook

Example

GET /api/v2/orderbook?market_pair=BTC_ETH

GET /api/v2/orderbook?market_pair=BTC_ETH&depth;=2

PARAMETERS

Param	Type	Description
market_pair	String	Market Pair e.g "BTC_ETH"
depth	Integer	(optional) Orders depth quantity: [0, 2, 4, 6, ...]. 0 returns full depth. Depth = 2 means 1 for each bid / ask side. Depth = 4 means 2 for each bid / ask side. and so on multiples of 2.

RESPONSES

Field	Description
timestamp	Timestamp
bids	bid list (price, size)
asks	ask list (price, size)

Get Trades

Result example :

[
    {
        "trade_id": 607,
        "price": "0.03423297",
        "base_volume": 0.01000000,
        "quote_volume": "0.01025437",
        "timestamp": 1600961666,
        "type": "buy"
    },
    {
        "trade_id": 18,
        "price": "0.05422000",
        "base_volume": 0.01025437,
        "quote_volume": "0.01000000",
        "timestamp": 1599786136,
        "type": "sell"
    }
]

Request via this endpoint to return data on all recently completed trades for a given market pair.

HTTP REQUEST

GET /api/v2/trades

Example

GET /api/v2/trades?market_pair=BTC_ETH

PARAMETERS

Param	Type	Description
market_pair	String	Market pair e.g. "BTC_ETH"

RESPONSES

Field	Description
trade_id	Trade identity
price	Price
base_volume	Base volume
quote_volume	Quote volume
timestamp	Timestamp
type	"buy" or "sell"

Aset Data

V1

This url endpoint to access v1 api :
https://crypxie.com/api/v1

Get Assets

Result example :

{
    "result": [
        {
            "asset_symbol": "BTC",
            "asset_name": "Bitcoin"
        },
        {
            "asset_symbol": "ETH",
            "asset_name": "Ethereum"
        },
        {
            "asset_symbol": "LTC",
            "asset_name": "Litecoin"
        }
    ],
    "success": true
}

Request via this endpoint to provides a summary of all assets supported by a platform.

HTTP REQUEST

GET /api/v1/assets

Example

GET /api/v1/assets

RESPONSES

Field	Description
asset_symbol	Symbol of aset, e.g. BTC.
asset_name	Name of aset,e.g. Bitcoin

V2

This url endpoint to access v2 api :
https://crypxie.com/api/v2

Get Assets

Result example :

{
    "BTC": {
        "name":"Bitcoin",
        "unified_cryptoasset_id":80,
        "can_withdraw":true,
        "can_deposit":true,
        "min_withdraw":"0.00100000",
        "max_withdraw ":"1000.00000000",
        "maker_fee":"0.05",
        "taker_fee":"0.05"
    },
    "ETH": {
        "name":"Ethereum",
        "unified_cryptoasset_id":79,
        "can_withdraw":true,
        "can_deposit":true,
        "min_withdraw":"0.01000000",
        "max_withdraw ":"10000.00000000",
        "maker_fee":"0.05",
        "taker_fee":"0.05"
    }
}

Request via this endpoint to provide a detailed summary for each currency available on the exchange

HTTP REQUEST

GET /api/v2/assets

Example

GET /api/v2/assets

RESPONSES

Field	Description
name	Name of asset
unified_cryptoasset_id	Aset Identity
can_withdraw	"true" Can be withdrawn, "false" Can't be withdrawn
can_deposit	"true" Can make deposit, "false" Can' not't make deposit
min_withdraw	Minimum Withdrawal
max_withdraw	Maximum Withdrawal
maker_fee	Maker fee
taker_fee	Taker fee