Skip to content

Public API

src.coinspot.PublicAPIV2

latest(coin=None, market_type=None)

Get latest coin prices

Parameters:

Name Type Description Default
coin str

(optional) Coin short name, eg. BTC, ETH, LTC

None
market_type str

(optional, available markets only, default 'AUD') market coin short name, example values 'AUD', 'USDT'

None

Returns:

Type Description
dict

coin=None market_type=None: {"status":"ok", "message":"ok", "prices":{"btc":{"bid":11111, "ask":222222, "last":1111.11}, ...}} coin=ABC market_type=None: {"status":"ok", "message":"ok", "prices":{"bid":11111, "ask":222222, "last":1111.11}} coin=ABC market_type=XYZ: {"status":"ok", "message":"ok", "prices":{"bid":11111, "ask":222222, "last":1111.11}}

buy_price(coin, market_type=None)

Get latest buy price for {coin}

Parameters:

Name Type Description Default
coin str

Coin short name, eg. BTC, ETH, LTC

required
market_type str

(optional, available markets only, default 'AUD') market coin short name, example values 'AUD', 'USDT'

None

Returns:

Type Description
dict

coin=ABC market_type=None: {"status":"ok", "message":"ok", "rate":11111, "market": "ABC/AUD"} coin=ABC market_type=XYZ: {"status":"ok", "message":"ok", "rate":11111, "market": "ABC/XYZ"}

sell_price(coin, market_type=None)

Get latest sell price for {coin}

Parameters:

Name Type Description Default
coin str

Coin short name, eg. BTC, ETH, LTC

required
market_type str

(optional, available markets only, default 'AUD') market coin short name, example values 'AUD', 'USDT'

None

Returns:

Type Description
dict

coin=ABC market_type=None: {"status":"ok", "message":"ok", "rate":11111, "market": "ABC/AUD"} coin=ABC market_type=XYZ: {"status":"ok", "message":"ok", "rate":11111, "market": "ABC/XYZ"}

open_orders(coin, market_type=None)

List open orders for {coin}

Parameters:

Name Type Description Default
coin str

Coin short name, eg. BTC, ETH, LTC

required
market_type str

(optional, available markets only, default 'AUD') market coin short name, example values 'AUD', 'USDT'

None

Returns:

Type Description
dict

coin=ABC market_type=None: {"status":"ok", "message":"ok", "buyorders":[{"amount":0.1, "rate":111111, "total":111111, "coin":"ABC", "market":"ABC/AUD"}, ...], "sellorders":[{"amount":0.0001, "rate":1111111, "total":1.111, "coin":"ABC", "market":"ABC/AUD"}, ...]} coin=ABC market_type=XYZ: {"status":"ok", "message":"ok", "buyorders":[{"amount":0.1, "rate":111111, "total":111111, "coin":"ABC", "market":"ABC/XYZ"}, ...], "sellorders":[{"amount":0.0001, "rate":1111111, "total":1.111, "coin":"ABC", "market":"ABC/XYZ"}, ...]}

completed_orders(coin, market_type=None)

List completed orders for {coin}

Parameters:

Name Type Description Default
coin str

Coin short name, eg. BTC, ETH, LTC

required
market_type str

(optional, available markets only, default 'AUD') market coin short name, example values 'AUD', 'USDT'

None

Returns:

Type Description
dict

coin=ABC market_type=None: {"status":"ok", "message":"ok", "buyorders":[{"amount":0.1, "rate":111111, "total":111111, "coin":"ABC", "solddate":"2020-05-21T13:22:45.000Z", "market":"ABC/AUD"}, ...], "sellorders":[{"amount":0.0001, "rate":1111111, "total":1.111, "coin":"ABC", "solddate":"2020-05-21T13:22:45.000Z", "market":"ABC/AUD"}, ...]} coin=ABC market_type=XYZ: {"status":"ok", "message":"ok", "buyorders":[{"amount":0.1, "rate":111111, "total":111111, "coin":"ABC", "solddate":"2020-05-21T13:22:45.000Z", "market":"ABC/XYZ"}, ...], "sellorders":[{"amount":0.0001, "rate":1111111, "total":1.111, "coin":"ABC", "solddate":"2020-05-21T13:22:45.000Z", "market":"ABC/XYZ"}, ...]}