Summary

This page will provide basic documentation on using the CoinSpot API.

To use this API you need to generate an API key, you generate your API key from the settings page in your account. Please note that you must be registered customer to use the API, registering is free and only takes a minute, you can register here.

Important things to note
All requests and responses will be JSON
All requests will be made with the POST method.

The endpoint for the API is https://www.coinspot.com.au/api
The endpoint for the Public API is https://www.coinspot.com.au/pubapi

Read Only API
We have a Read Only API available, you can read the documentation for the read only API here.

SDK

We currently have a node.js SDK, if you are interested in getting an SDK in another language Contact us

node.js - https://www.npmjs.org/package/coinspot-api

Latest Prices

Url

https://www.coinspot.com.au/pubapi/latest

Inputs

none

Response

status - ok, error
prices - object containing one property for each coin with the latest prices for that coin

Security

The API is secured using by using the shared secret key to create a HMAC with the SHA512 cryptographic hash function. Hash-based message authentication code (HMAC) is a mechanism for calculating a message authentication code involving a hash function in combination with a secret key. This can be used to verify the integrity and authenticity of a a message.

All requests to the API will need to include the following security data.

Headers

key - Your API key generated from the settings page
sign - The POST data is to be signed using your secret key according to HMAC-SHA512 method.

Post Params

nonce - Any integer value which must always be greater than the previous requests nonce value.

List Open Orders

Url

/orders

Inputs

cointype - the coin shortname, example value 'BTC', 'LTC', 'DOGE'

Response

status - ok, error
buyorders - array containing all the open buy orders
sellorders - array containing all the open sell orders

List Order History

Url

/orders/history

Inputs

cointype - the coin shortname, example value 'BTC', 'LTC', 'DOGE'

Response

status - ok, error
orders - list of the last 1000 completed orders

Deposit Coins

Url

/my/coin/deposit

Inputs

cointype - the coin shortname, example value 'BTC', 'LTC', 'DOGE'

Response

status - ok, error
address - your deposit address for the coin

Quick Buy Quote

Url

/quote/buy

Inputs

cointype - the coin shortname, example value 'BTC', 'LTC', 'DOGE'
amount - the amount of coins to buy

Response

status - ok, error
quote - the rate per coin
timeframe - estimate hours to wait for trade to complete (0 = immediate trade)

Quick Sell Quote

Url

/quote/sell

Inputs

cointype - the coin shortname, example value 'BTC', 'LTC', 'DOGE'
amount - the amount of coins to sell

Response

status - ok, error
quote - the rate per coin
timeframe - estimate hours to wait for trade to complete (0 = immediate trade)

List My Balances

Url

/my/balances

Inputs

none

Response

status - ok, error
balances - object containing one property for each coin with your balance for that coin.

List My Orders

A list of your open orders by coin type, it will return a maximum of 100 results

Url

/my/orders

Inputs

none

Response

status - ok, error
buyorders - array containing all your buy orders
sellorders - array containing all your sell orders

Place Buy Order

Url

/my/buy

Inputs

cointype - the coin shortname, example value 'BTC', 'LTC', 'DOGE'
amount - the amount of coins you want to buy, max precision 8 decimal places
rate - the rate in AUD you are willing to pay, max precision 6 decimal places

Response

status - ok, error

Place Sell Order

Url

/my/sell

Inputs

cointype - the coin shortname, example value 'BTC', 'LTC', 'DOGE'
amount - the amount of coins you want to sell, max precision 8 decimal places
rate - the rate in AUD you are willing to sell for, max precision 6 decimal places

Response

status - ok, error

Cancel Buy Order

Url

/my/buy/cancel

Inputs

id - the id of the order to cancel

Response

status - ok, error

Cancel Sell Order

Url

/my/sell/cancel

Inputs

id - the id of the order to cancel

Response

status - ok, error

Read Only API

We have a Read Only API available.
To use this API, you need to generate a Read Only API key from the settings page.

Important things to note about the read only API
All requests and responses will be JSON.
All requests will be made with the POST method.

The endpoint for the Read Only API is https://www.coinspot.com.au/api/ro

List My Balances

Url

https://www.coinspot.com.au/api/ro/my/balances

Inputs

none

Response

status - ok, error
balances - array containing one object for each coin with your balance, AUD value and rate for that coin

List a Coins Balance

Url

/api/ro/my/balances/:cointype

Inputs

cointype - the coin shortname, example value 'BTC', 'LTC', 'DOGE'

Response

status - ok, error
balance - object containing one property with your balance, AUD value and rate for that coin

List Deposit History

Url

/api/ro/my/deposits

Inputs

startdate - (optional) format 'YYYY-MM-DD'
enddate - (optional) format 'YYYY-MM-DD'

Response

status - ok, error
deposits - array containing your AUD deposit history

List Withdrawal History

Url

/api/ro/my/withdrawals

Inputs

startdate - (optional) format 'YYYY-MM-DD'
enddate - (optional) format 'YYYY-MM-DD'

Response

status - ok, error
withdrawals - array containing your AUD withdrawal history

List My Transaction History

Url

/api/ro/my/transactions

Inputs

startdate - (optional) format 'YYYY-MM-DD'
enddate - (optional) format 'YYYY-MM-DD'

Response

status - ok, error
buyorders - array containing your buy order history
sellorders - array containing your sell order history

List My Coin Transaction History

Url

/api/ro/my/transactions/:cointype

Inputs

cointype - the coin shortname, example value 'BTC', 'LTC', 'DOGE'
startdate - (optional) format 'YYYY-MM-DD'
enddate - (optional) format 'YYYY-MM-DD'

Response

status - ok, error
buyorders - array containing your coins buy order history
sellorders - array containing your coins sell order history

List My Open Transactions

Url

/api/ro/my/transactions/open

Inputs

none

Response

status - ok, error
buyorders - array containing your open buy orders
sellorders - array containing your open sell orders

List My Coins Open Transactions

Url

/api/ro/my/transactions/:cointype/open

Inputs

cointype - the coin shortname, example value 'BTC', 'LTC', 'DOGE'

Response

status - ok, error
buyorders - array containing your coins open buy orders
sellorders - array containing your coins open sell orders

List My Send & Receive Transaction History

Url

/api/ro/my/sendreceive

Inputs

none

Response

status - ok, error
sendtransactions - array containing your coin send transaction history
receivetransactions - array containing your coin receive transaction history

List My Affiliate Payments

Url

/api/ro/my/affiliatepayments

Inputs

none

Response

status - ok, error
payments - array containing one object for each completed affiliate payment

List My Referral Payments

Url

/api/ro/my/referralpayments

Inputs

none

Response

status - ok, error
payments - array containing one object for each completed referral payment