API | CoinSpot

Contents

Security
SDK

Public API

API

Read Only API

Legacy API (V1) Still Active At This Stage

The previous (V1) API is still active for legacy purposes but it is recommended users migrate to the new V2 API version - though it still remains technically in BETA status the V2 API is considered stable.

If required, documentation for the old (V1) API is available here.

V2 Summary

This page provides basic documentation on using the CoinSpot API.

To use this API you need to generate an API key. You can generate an API key from the API page after logging in to your account at: https://www.coinspot.com.au/my/api. Please note that you must be a registered customer to use the API except for the Public API - registering is free and only takes a minute, you can register here.

Important things to note
All requests and responses will be JSON format
All response date and time values will be in UTC format e.g. 2020-05-21T13:22:45.000Z
All requests will be made with the GET method for the Public API and POST method for all other API requests.
All requests will return a 200 http status code if successful, any other status code received indicates request failure and a message value in the response will describe the issue encountered.
Requests are limited to 1000 requests per minute.

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

Read Only API
There is also a Read Only API available, you can read the documentation for the read only API here.
The endpoint for the Read Only API is https://www.coinspot.com.au/api/v2/ro

Example error response

All errors returned will contain an error status and a message that describes the issue encountered

{
   "status":"error",
   "message":"Coin not found"
}

Security

The API is secured by using a 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 POST API requests 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.

SDK

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

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

Latest Prices

Url

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

Inputs

none

Response

status - ok, error
message - ok, description of error if error occurred
prices - array of objects with one set of properties for each coin with latest buy and sell prices, non aud markets are symbolised by (e.g.) 'btc_usdt'

Example response

{
	"status":"ok",
	"message":"ok",
	"prices":{
		"btc":{
			"bid":11111,
			"ask":222222,
			"last":1111.11
		},
		"btc_usdt":{
			"bid":11111,
			"ask":222222,
			"last":1111.11
		},
		"ltc":{
			"bid":1.11111,
			"ask":111,
			"last":111
		},
		"doge":{
			"bid":1.111111,
			"ask":1.111111,
			"last":1.11111
		}
	}
}

Latest Coin Prices

Url

https://www.coinspot.com.au/pubapi/v2/latest/{cointype}

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'

Response

status - ok, error
message - ok, description of error if error occurred
prices - object with set of properties for coin with latest buy, ask and last prices

Example response

{
	"status":"ok",
	"message":"ok",
	"prices":{
		"bid":11111,
		"ask":222222,
		"last":1111.11
	}
}

Latest Coin / Market Prices

Url

https://www.coinspot.com.au/pubapi/v2/latest/{cointype}/{markettype}

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'
markettype - market coin short name, example value 'USDT' (only for available markets)

Response

status - ok, error
message - ok, description of error if error occurred
prices - object with set of properties for coin with latest buy, ask and last prices

Example response

{
	"status":"ok",
	"message":"ok",
	"prices":{
		"bid":11111,
		"ask":222222,
		"last":1111.11
	}
}

Latest Buy Price

Url

https://www.coinspot.com.au/pubapi/v2/buyprice/{cointype}

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'

Response

status - ok, error
message - ok, description of error if error occurred
rate - latest buy price for that coin
market - market coin is trading in

Example response

{
   "status":"ok",
   "message":"ok",
   "rate":11111,
   "market": "BTC/AUD"
}

Latest Buy Price / Market

Url

https://www.coinspot.com.au/pubapi/v2/buyprice/{cointype}/{markettype}

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'
markettype - coin market you wish to use to buy it, example value: USDT' (only for available markets)

Response

status - ok, error
message - ok, description of error if error occurred
rate - latest buy price for that coin
market - market coin is trading in

Example response

{
   "status":"ok",
   "message":"ok",
   "rate":11111,
   "market": "BTC/USDT"
}

Latest Sell Price

Url

https://www.coinspot.com.au/pubapi/v2/sellprice/{cointype}

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'

Response

status - ok, error
message - ok, description of error if error occurred
rate - latest sell price for that coin
market - market coin is trading in

Example response

{
   "status":"ok",
   "message":"ok",
   "rate":11111,
   "market": "BTC/AUD"
}

Latest Sell Price / Market

Url

https://www.coinspot.com.au/pubapi/v2/sellprice/{cointype}/{markettype}

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'
markettype - coin market you wish to sell it for, example value: 'USDT' (note: only for available markets)

Response

status - ok, error
message - ok, description of error if error occurred
rate - latest sell price for that coin
market - market coin is trading in

Example response

{
   "status":"ok",
   "message":"ok",
   "rate":11111,
   "market": "BTC/USDT"
}

Open Orders By Coin

Url

https://www.coinspot.com.au/pubapi/v2/orders/open/{cointype}

Inputs

cointype - the coin short name, example value 'BTC', 'LTC', 'DOGE'

Response

status - ok, error
message - ok, description of error if error occurred
buyorders - list of top 100 open AUD buy orders for the given coin
sellorders - list of top 100 open AUD sell orders for the given coin

Example response

{
   "status":"ok",
   "message":"ok",
   "buyorders":[
      {
         "amount":0.1,
         "rate":111111,
         "total":111111,
         "coin":"BTC",
         "market":"BTC/AUD",
      },
      {
         "amount":0.1,
         "rate":1111112,
         "total":111111,
         "coin":"BTC",
         "market":"BTC/AUD"
      },
     
   ],
   "sellorders":[
      {
         "amount":0.0001,
         "rate":1111111,
         "total":1.111,
         "coin":"BTC",
         "market":"BTC/AUD"
      },
      {
         "amount":0.0002,
         "rate":111111,
         "total":2.1111,
         "coin":"BTC",
         "market":"BTC/AUD"
      }
   ]
}

Open Orders By Coin / Market

Url

https://www.coinspot.com.au/pubapi/v2/orders/open/{cointype}/{markettype}

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'
markettype - coin market, example values 'USDT' (note: only for available markets)

Response

status - ok, error
message - ok, description of error if error occurred
buyorders - list of top 20 open buy order rates for the given coin / market
sellorders - list of top 20 open sell order rates for the given coin / market

Example response

{
   "status":"ok",
   "message":"ok",
   "buyorders":[
      {
         "amount":0.1,
         "rate":111111,
         "total":111111,
         "coin":"BTC",
         "market":"BTC/USDT",
      },
      {
         "amount":0.1,
         "rate":1111112,
         "total":111111,
         "coin":"BTC",
         "market":"BTC/USDT",
      },
     
   ],
   "sellorders":[
      {
         "amount":0.0001,
         "rate":1111111,
         "total":1.111,
         "coin":"BTC",
         "market":"BTC/USDT",
      },
      {
         "amount":0.0002,
         "rate":111111,
         "total":2.1111,
         "coin":"BTC",
         "market":"BTC/USDT",
      }
   ]
}

Completed Orders By Coin

Url

https://www.coinspot.com.au/pubapi/v2/orders/completed/{cointype}

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'

Response

status - ok, error
message - ok, description of error if error occurred
buyorders - list of top 100 completed AUD buy orders for the given coin
sellorders - list of top 100 completed AUD sell orders for the given coin

Example response

{
   "status":"ok",
   "message":"ok",
   "buyorders":[
      {
         "amount":0.1,
         "rate":111111,
         "total":111111,
         "coin":"BTC",
         "solddate":"2020-05-21T13:22:45.000Z",
         "market":"BTC/AUD",
      },
      {
         "amount":0.1,
         "rate":1111112,
         "total":111111,
         "coin":"BTC",
         "solddate":"2020-05-21T13:22:45.000Z",
         "market":"BTC/AUD",
      },
     
   ],
   "sellorders":[
      {
         "amount":0.0001,
         "rate":1111111,
         "total":1.111,
         "coin":"BTC",
         "solddate":"2020-05-21T13:22:45.000Z",
         "market":"BTC/AUD",
      },
      {
         "amount":0.0002,
         "rate":111111,
         "total":2.1111,
         "coin":"BTC",
         "solddate":"2020-05-21T13:22:45.000Z",
         "market":"BTC/AUD",
      }
   ]
}

Completed Orders By Coin / Market

Url

https://www.coinspot.com.au/pubapi/v2/orders/completed/{cointype}/{markettype}

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'
markettype - coin market, example values 'USDT' (note: only for available markets)

Response

status - ok, error
message - ok, description of error if error occurred
buyorders - list of top 100 completed buy orders for the given coin / market
sellorders - list of top 100 completed sell orders for the given coin / market

Example response

{
"status":"ok",
"message":"ok",
"buyorders":[
	{
		"amount":0.1,
		"rate":111111,
		"total":111111,
		"coin":"BTC",
		"solddate":"2020-05-21T13:22:45.000Z",
		"market":"BTC/USDT",
	},
	{
		"amount":0.1,
		"rate":1111112,
		"total":111111,
		"coin":"BTC",
		"solddate":"2020-05-21T13:22:45.000Z",
		"market":"BTC/USDT",
	},
	
],
"sellorders":[
	{
		"amount":0.0001,
		"rate":1111111,
		"total":1.111,
		"coin":"BTC",
		"solddate":"2020-05-21T13:22:45.000Z",
		"market":"BTC/USDT",
	},
	{
		"amount":0.0002,
		"rate":111111,
		"total":2.1111,
		"coin":"BTC",
		"solddate":"2020-05-21T13:22:45.000Z",
		"market":"BTC/USDT",
	}
]
}

Completed Orders By Coin (Summary Only)

Url

https://www.coinspot.com.au/pubapi/v2/orders/summary/completed/{cointype}

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'

Response

status - ok, error
message - ok, description of error if error occurred
orders - list of top 100 completed AUD orders for the given coin - not separated into buy/sell orders

Example response

{
   "status":"ok",
   "message":"ok",
   "orders":[
      {
         "amount":0.1,
         "rate":111111,
         "total":111111,
         "coin":"BTC",
         "solddate":"2020-05-21T13:22:45.000Z",
         "market":"BTC/AUD",
      },
   ],
}

Completed Orders By Coin / Market (Summary Only)

Url

https://www.coinspot.com.au/pubapi/v2/orders/summary/completed/{cointype}/{markettype}

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'
markettype - coin market, example values 'USDT' (note: only for available markets)

Response

status - ok, error
message - ok, description of error if error occurred
orders - list of top 100 completed orders for the given coin / market - not separated into buy/sell orders

Example response

{
"status":"ok",
"message":"ok",
"orders":[
	{
		"amount":0.1,
		"rate":111111,
		"total":111111,
		"coin":"BTC",
		"solddate":"2020-05-21T13:22:45.000Z",
		"market":"BTC/USDT",
	},
	{
		"amount":0.1,
		"rate":1111112,
		"total":111111,
		"coin":"BTC",
		"solddate":"2020-05-21T13:22:45.000Z",
		"market":"BTC/USDT",
	},
	
],
}

Full Access Status Check

Url

Root: https://www.coinspot.com.au/api/v2
Request /status

Inputs

none

Response

status - ok

Example response

	{
	"status":"ok"
	}

My Coin Deposit Address

Url

Root: https://www.coinspot.com.au/api/v2
Request /my/coin/deposit

Inputs

cointype coin short name, example value 'BTC', 'LTC', 'DOGE'

Response

status - ok, error
message - ok, description of error if error occurred
networks - list of available networks (fields below)

name - network name
network - network type
address - your deposit address for the coin
memo - your memo / tag for the coin (where required)

Example response

{
   "status":"ok",
   "message":"ok",
   "networks": [
	{"name": "BEP2", "network": "BNB", "address": "bnbabcdef123456abcdef123456", "memo": "123456"},
	{"name": "ERC20", "network": "ETH", "address": "0xabcdef123456abcdef123456", "memo": ""}
    ]
}

Buy Now Quote

Url

Root: https://www.coinspot.com.au/api/v2
Request /quote/buy/now

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'
amount - amount to buy
amounttype - 'coin' or 'aud' - whether the amount above is coin amount or AUD amount

Response

status - ok, error
message - ok, description of error if error occurred
rate - rate per specified coin

Example response

{
   "status":"ok",
   "message":"ok",
   "rate":1111
}

Sell Now Quote

Url

Root: https://www.coinspot.com.au/api/v2
Request /quote/sell/now

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'
amount - amount of coins to sell
amounttype - 'coin' or 'aud' - whether the amount below is coin amount or AUD amount

Response

status - ok, error
message - ok, description of error if error occurred
rate - rate per specified coin inclusive of fee

Example response

{
   "status":"ok",
   "message":"ok",
   "rate":11111
}

Swap Now Quote

Url

Root: https://www.coinspot.com.au/api/v2
Request /quote/swap/now

Inputs

Response

status - ok, error
message - ok, description of error if error occurred
rate - rate per coin swapped exclusive of fee

Example response

{
   "status":"ok",
   "message":"ok",
   "rate":11111
}

Place Market Buy Order

Url

Root: https://www.coinspot.com.au/api/v2
Request /my/buy

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'
amount - mount of coins you want to buy, max precision 8 decimal places
rate - rate in market currency (e.g. AUD or USDT) you are willing to pay, max precision 8 decimal places
markettype - (optional, available markets only, default 'AUD') market coin short name to use to buy the coin, example value 'USDT'

Response

status - ok, error
message - ok, description of error if error occurred
coin - coin short name, example value 'BTC', 'LTC', 'DOGE'
market - market used to place buy order for the coin
amount - coin amount that was placed
rate - rate that order was placed at
id - id of buy order created which can be used to cancel the order if desired

Example response

{
   "status":"ok",
   "message":"ok",
   "coin":"BTC",
   "market": "BTC/AUD",
   "amount":1.234
   "rate":123.344
   "id":"12345678901234567890"
}

Edit Open Market Buy Order

Url

Root: https://www.coinspot.com.au/api/v2
Request /my/buy/edit

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'
id - order id of the target buy order
rate - current rate in market currency (e.g. AUD or USDT) of the open order, max precision 8 decimal places
newrate - proposed rate in market currency (e.g. AUD or USDT) to edit the open order, max precision 8 decimal places

Response

status - ok, error
message - ok, description of error if error occurred

(on success)

updated - true
coin - coin short name, example value 'BTC', 'LTC', 'DOGE'
rate - new rate that order has been placed at
newrate - requested rate
amount - coin amount calculated as a result of the rate adjustment
total - total is not adjusted from original order
id - id of the edited buy order (unchanged)

Example response

{
   "status":"ok",
   "message":"ok",
   "id":"12345678901234567890"
   "coin":"BTC",
   "rate": "1234556",
   "newrate": "1234556",
   "amount":1.234,
   "total": 1234,
   "updated": true
}

Place Buy Now Order

Url

Root: https://www.coinspot.com.au/api/v2
Request /my/buy/now

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'
amounttype - 'coin' or 'aud' - whether the amount below is coin amount or AUD amount
amount - amount to buy, max precision for coin is 8 decimal places and 2 decimal places for AUD

Optional
Note 1: if rate option below is submitted a threshold value must also be submitted
Note 2: buy will occur at current rate not submitted rate

rate - (optional) rate in AUD received from using Buy Now Quote or otherwise
threshold - (optional) 0 to 1000 - buy request will terminate if not within percentage threshold for current rate to vary from submitted rate, max precision for percentage is 8 decimal places

direction - (optional) UP, DOWN, or BOTH (default is UP) - direction the price has moved for the percentage threshold to apply

Response

status - ok, error
message - ok, description of error if error occurred
coin - coin short name, example value 'BTC', 'LTC', 'DOGE'
market - market used to place buy order for the coin
amount - amount that was bought
total - total amount in market currency

Example response

{
   "status":"ok",
   "message":"ok",
   "coin":"BTC",
   "amount":1.234,
   "market":"BTC/AUD",
   "total": 10.234
}

Place Market Sell Order

Url

Root: https://www.coinspot.com.au/api/v2
Request /my/sell

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'
amount - amount of coins you want to sell, max precision 8 decimal places
rate - rate in AUD you are willing to sell for, max precision 8 decimal places
markettype - (optional, available markets only, default 'AUD') market coin short name to use to sell the coin into, example value 'USDT'

Response

status - ok, error
message - ok, description of error if error occurred
coin - coin short name
market - market used to place sell order for the coin
amount - coin amount that was placed in order
rate - rate that order was placed at
id - id of sell order created which can be used to cancel the order if desired

Example response

{
   "status":"ok",
   "message":"ok",
   "coin":"BTC",
   "market": "BTC/AUD",
   "amount":1.234,
   "rate":123.344,
   "id":"12345678901234567890"
}

Edit Open Market Sell Order

Url

Root: https://www.coinspot.com.au/api/v2
Request /my/sell/edit

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'
id - order id of the target sell order
rate - current rate in market currency (e.g. AUD or USDT) of the open order, max precision 8 decimal places
newrate - proposed rate in market currency (e.g. AUD or USDT) to edit the open order, max precision 8 decimal places

Response

status - ok, error
message - ok, description of error if error occurred

(on success)

updated - true
coin - coin short name, example value 'BTC', 'LTC', 'DOGE'
rate - new rate that order has been placed at
newrate - requested rate
amount - amount is not adjusted from original order
total - total calculated as a result of the rate adjustment
id - id of the edited sell order (unchanged)

Example response

{
   "status":"ok",
   "message":"ok",
   "id":"12345678901234567890",
   "coin":"BTC",
   "rate": "1234556",
   "newrate": "1234556",
   "amount": 1234,
   "total":1.234,
   "updated": true
}

Place Sell Now Order

Url

Root: https://www.coinspot.com.au/api/v2
Request /my/sell/now

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'
amounttype - 'coin' or 'aud' - whether the amount below is coin amount or AUD amount
amount - amount of coins you want to sell, max precision 8 decimal places

Optional
Note 1: if rate option below is submitted a threshold value must also be submitted
Note 2: sell will occur at current rate not submitted rate

rate - (optional) rate in AUD received from using Sell Now Quote or otherwise
threshold - (optional) 0 to 1000 - sell request will terminate if not within percentage threshold for current rate to vary from submitted rate, max precision for percentage is 8 decimal places

direction - (optional) UP, DOWN, or BOTH (default is DOWN) - direction the price has moved for the percentage threshold to apply

Response

status - ok, error
message - ok, description of error if error occurred
coin - coin short name, example value 'BTC', 'LTC', 'DOGE'
market - market used to place sell order for the coin
amount - amount that was sold
rate - rate that order was placed at
total - total amount in market currency

Example response

{
  "status":"ok",
   "message":"ok",
   "coin":"BTC",
   "amount":1.234,
   "rate":3.234,
   "market":"BTC/AUD",
   "total": 10.234
}

Place Swap Now Order

Url

Root: https://www.coinspot.com.au/api/v2
Request /my/swap/now

Inputs

cointypesell - coin short name you would like to swap, example value 'BTC', 'LTC', 'DOGE'
cointypebuy - coin short name you wuld like to swap it for, example value 'BTC', 'LTC', 'DOGE'
amount - amount of (cointypesell) to swap, max precision for coin is 8 decimal places

Optional
Note 1: if rate option below is submitted a threshold value must also be submitted
Note 2: swap will occur at current rate not submitted rate

rate - (optional) rate received from using Swap Now Quote or otherwise
threshold - (optional) 0 to 1000 - swap request will terminate if not within percentage threshold for current rate to vary from submitted rate, max precision for percentage is 8 decimal places

direction - (optional) UP, DOWN, or BOTH (default is BOTH) - direction the price has moved for the percentage threshold to apply

Response

status - ok, error
message - ok, description of error if error occurred
coin - coin short name, example value 'BTC', 'LTC', 'DOGE'
market - coin swapped and and coin it was swapped for
amount - coin amount that was swapped
rate - rate that order was placed at
total - total amount in swapped coin currency

Example response

{
   "status":"ok",
   "message":"ok",
   "coin":"BTC",
   "amount":1.234,
   "rate":3.234,
   "market":"BTC/ETH",
   "total": 10.234
}

Cancel My Buy Order

Url

Root: https://www.coinspot.com.au/api/v2
Request /my/buy/cancel

Inputs

id - id of the buy order to cancel

Note 1: 'ok' response means attempt to cancel has been successfully lodged, the cancel request still may not succeed even though lodged if the buy process has already commenced

Note 2: Too many cancellations of open buy orders may trigger rate limiting of future buys. If frequently changing rates please use the 'edit buy order' function instead.

Response

status - ok, error
message - ok, description of error if error occurred

Example response

{
   "status":"ok",
   "message":"ok"
}

Cancel My Buy Orders All

Url

Root: https://www.coinspot.com.au/api/v2
Request /my/buy/cancel/all

Inputs

coin - (optional) coin of the buy orders to cancel

Note 1: 'ok' response means attempt to cancel orders has been successfully lodged, the cancel requests still may not succeed even though lodged if the buy process has already commenced

Note 2: Too many cancellations of open buy orders may trigger rate limiting of future buys. If frequently changing rates please use the 'edit buy order' function instead.

Response

status - ok, error
message - ok, description of error if error occurred

Example response

{
   "status":"ok",
   "message":"ok"
}

Cancel My Sell Order

Url

Root: https://www.coinspot.com.au/api/v2
Request /my/sell/cancel

Inputs

id - id of the sell order to cancel

Note 1: 'ok' response means attempt to cancel has been successfully lodged, the cancel request still may not succeed even though lodged if the sell process has already commenced

Note 2: Too many cancellations of open sell orders may trigger rate limiting of future sells. If frequently changing rates please use the 'edit sell order' function instead.

Response

status - ok, error
message - ok, description of error if error occurred

Example response

{
   "status":"ok",
   "message":"ok"
}

Cancel My Sell Orders All

Url

Root: https://www.coinspot.com.au/api/v2
Request /my/sell/cancel/all

Inputs

coin - (optional) coin of the sell orders to cancel

Note 1: 'ok' response means attempt to cancel orders has been successfully lodged, the cancel requests still may not succeed even though lodged if the sell process has already commenced

Note 2: Too many cancellations of open sell orders may trigger rate limiting of future sells. If frequently changing rates please use the 'edit sell order' function instead.

Response

status - ok, error
message - ok, description of error if error occurred

Example response

{
   "status":"ok",
   "message":"ok"
}

Get Coin Withdrawal Details

NOTE: ** This function must be ENABLED via the API key options available when logged in at https://www.coinspot.com.au/my/api

Url

Root: https://www.coinspot.com.au/api/v2
Request /my/coin/withdraw/senddetails

Inputs

cointype - coin short name you would like to withdraw, example value 'BTC', 'LTC', 'DOGE'

Response

status - ok, error
message - ok, description of error if error occurred
networks - list of available send networks

Example response

NOTE: network details are subject to change, please check occasionally

{
   "status":"ok",
   "message":"ok",
   "networks": [
	{ "network": "BNB", "paymentid": "no", "fee": 0.001, "minsend": 0.00001, default: false},
	{ "network": "BSC", "paymentid": "optional", "fee": 0.002, "minsend": 0.00001, default: false},
	{ "network": "ETH", "paymentid": "no", "fee":0.003, "minsend": 0.00001, default: true},
    ]
  
}

Coin Withdrawal

NOTE: ** This function must be ENABLED via the API key options available when logged in at https://www.coinspot.com.au/my/api

Url

Root: https://www.coinspot.com.au/api/v2
Request /my/coin/withdraw/send

Inputs

NOTE: for network and paymentid details please see 'Get Coin Withdrawal Details' above

cointype - coin short name you would like to withdraw, example values 'BTC', 'LTC', 'DOGE'
amount - the amount (in coin currency) of coin you would like to withdraw
address - the destination address for the coin amount'
emailconfirm - (optional, default is 'NO') if 'YES' an email confirmation will be sent and withdraw will not complete until confirmation link within email is clicked, values: 'YES', 'NO'
network - (optional) - network you would like to send using e.g. 'BNB', 'ETH' - omit for 'default' network
paymentid - (optional) - the appropriate payment id/memo for the withdrawal where permitted

Response

status - ok, error
message - ok, description of error if error occurred

Example response

{
   "status":"ok",
   "message":"ok"
}

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/v2/ro

Read Only Status Check

Url

Root: https://www.coinspot.com.au/api/v2/ro
Request /status

Inputs

none

Response

status - ok

Example response

{
   "status":"ok"
}

Open Market Orders

Url

Root: https://www.coinspot.com.au/api/v2/ro
Request /orders/market/open

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'
markettype - (optional, available markets only)) market coin short name, example values 'AUD', 'USDT'

Response

status - ok, error
message - ok, description of error if error occurred
buyorders - list of top 20 open buy order rates for the given coin
sellorders - list of top 20 open sell orders rates for the given coin

Example response

{
   "status":"ok",
   "message":"ok",
   "buyorders":[
      {
         "amount":0.0001,
         "rate":111111,
         "total":0.1,
         "coin":"BTC",
         "market": "BTC/AUD"
      },
      {
         "amount":0.001,
         "rate":11111111,
         "total":0.01,
         "coin":"BTC",
         "market": "BTC/AUD"
      }
   ],
   "sellorders":[
      {
         "amount":0.0001,
         "rate":111111,
         "total":1,
         "coin":"BTC",
         "market": "BTC/AUD"
      },
      {
         "amount":0.0011855,
         "rate":11111,
         "total":2,
         "coin":"BTC",
         "market": "BTC/AUD"
      }
   ]
},

Completed Market Orders

Url

Root: https://www.coinspot.com.au/api/v2/ro
Request /orders/market/completed

Inputs

cointype - coin short name, example value 'BTC', 'LTC', 'DOGE'
markettype - (optional, available markets only)) market coin short name, example values 'AUD', 'USDT'
startdate - (optional, note: date is UTC date or UNIX EPOCH time) format 'YYYY-MM-DD' or e.g. 1614824116
enddate - (optional, note: date is UTC date or UNIX EPOCH time) format 'YYYY-MM-DD' or e.g. 1614824116
limit - (optional, default is 200 records, max is 500 records)

Response

status - ok, error
message - ok, description of error if error occurred
buyorders - list of top 100 completed buy orders for the given coin
sellorders - list of top 100 completed sell orders for the given coin

Example response

{
   "status":"ok",
   "message":"ok",
   "buyorders":[
      {
         "amount":0.0001,
         "rate":111111,
         "total":0.1,
         "coin":"BTC",
         "market": "BTC/AUD",
         "solddate":"2020-05-21T13:22:45.000Z",
         "audfeeExGst": 0.123,
      	 "audGst": 0.0123,
      	 "audtotal": 100.00
      },
      {
         "amount":0.001,
         "rate":11111111,
         "total":0.01,
         "coin":"BTC",
         "market": "BTC/USDT",
         "solddate":"2020-05-21T13:22:45.000Z",
         "audfeeExGst": 0.123,
      	 "audGst": 0.0123,
      	 "audtotal": 100.00
      }
   ],
   "sellorders":[
      {
         "amount":0.0001,
         "rate":111111,
         "total":1,
         "coin":"BTC",
         "market": "BTC/AUD",
         "solddate":"2020-05-21T13:22:45.000Z",
         "audfeeExGst": 0.123,
      	 "audGst": 0.0123,
      	 "audtotal": 100.00
      },
      {
         "amount":0.0001855,
         "rate":11111,
         "total":2,
         "coin":"BTC",
         "market": "BTC/USDT",
         "solddate":"2020-05-21T13:22:45.000Z",
         "audfeeExGst": 0.123,
      	 "audGst": 0.0123,
      	 "audtotal": 100.00
      }
   ]
},

My Coin Balances

Url

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

Inputs

none

Response

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

Example response

{
   "status":"ok",
   "message":"ok",
   "balances":[
      {
         "AUD":{
            "balance":1000.11,
            "audbalance":1000.11,
            "rate":1
         }
      },
      {
         "BTC":{
            "balance":1.1111111,
            "audbalance":2222.22,
            "rate":111111.11
         }
      },
      {
         "LTC":{
            "balance":111.111111,
            "audbalance":22222.22,
            "rate":11.1111
         }
      }]
}

My Coin Balance (Available)

Url

Root: https://www.coinspot.com.au/api/v2/ro
Request /my/balance/{cointype}?available={yes/no}

Inputs

cointype - coin short name, example value 'AUD', 'BTC', 'LTC', 'DOGE'
available - 'yes' or 'no', yes to return available balance in addition to actual balance

Response

status - ok, error
message - ok, description of error if error occurred
balance - object containing property with your actual/available balance, AUD value (actual balance) and rate for that coin

(note: available balance will be included in response if available option is set to 'yes')

Example response

{
   "status":"ok",
   "message":"ok",
   "balance":{
      "EOS":{
         "balance":1.11111,
         "available": 0.99999,
         "audbalance": 222.22,
         "rate": 1.11111
      }
   }
}

My Open Market Orders

Url

Root: https://www.coinspot.com.au/api/v2/ro
Request /my/orders/market/open

Inputs

cointype - (optional) coin short name, example value 'BTC', 'LTC', 'DOGE'
markettype - (optional) market coin short name, example value 'USDT', 'AUD'

Response

status - ok, error
message - ok, description of error if error occurred
buyorders - array containing your open buy orders
sellorders - array containing your open sell orders

Example response

{
   "status":"ok",
   "message":"ok",
   "buyorders":[
      {
         "id": "1f1f1f1f1d1d1d1d1d1d1d1d",
         "coin":"STRAT",
         "market":"STRAT/AUD",
         "amount":111.1111,
         "created":"2020-05-21T13:22:45.000Z",
         "rate":45.11111,
         "total":444444
      },
      {
         "id": "1f1f1f1f1d1d1d1d1d1d1d1d",
         "coin":"STRAT",
         "market":"STRAT/USDT",
         "amount":111.1111,
         "created":"2020-05-21T13:22:45.000Z",
         "rate":45.11111,
         "total":444444
      }]
   "sellorders":[
      {
         "id": "1f1f1f1f1d1d1d1d1d1d1d1d",
         "coin":"STRAT",
         "market":"STRAT/AUD",
         "amount":111.1111,
         "created":"2020-05-21T13:22:45.000Z",
         "rate":45.11111,
         "total":444444
      },
      {
         "id": "1f1f1f1f1d1d1d1d1d1d1d1d",
         "coin":"STRAT",
         "market":"STRAT/USDT",
         "amount":111.1111,
         "created":"2020-05-21T13:22:45.000Z",
         "rate":45.11111,
         "total":444444
      }}
   ]
}

My Open Limit Orders

Url

Root: https://www.coinspot.com.au/api/v2/ro
Request /my/orders/limit/open

Inputs

cointype - (optional) coin short name, example value 'BTC', 'LTC', 'DOGE'

Response

status - ok, error
message - ok, description of error if error occurred
buyorders - array containing your open buy orders
sellorders - array containing your open sell orders

Example response

{
   "status":"ok",
   "message":"ok",
   "buyorders":[
      {
         "id": "1f1f1f1f1d1d1d1d1d1d1d1d",
         "coin": "STRAT",
         "market":"STRAT/AUD",
         "rate": 111.111
         "amount":111.1111,
         "created":"2020-05-21T13:22:45.000Z",
         "type": "buy stop"
      },
      {
         "id": "1f1f1f1f1d1d1d1d1d1d1d1d",
         "coin": "STRAT",
         "market":"STRAT/AUD",
         "rate": 111.111
         "amount":111.1111,
         "created":"2020-05-21T13:22:45.000Z",
         "type": "buy limit"
      }]
   "sellorders":[
      {
         "id": "1f1f1f1f1d1d1d1d1d1d1d1d",
         "coin": "STRAT",
         "market":"STRAT/AUD",
         "rate": 111.111
         "amount":111.1111,
         "created":"2020-05-21T13:22:45.000Z",
         "type": "stop loss"
      },
      {
         "id": "1f1f1f1f1d1d1d1d1d1d1d1d",
         "coin": "STRAT",
         "market":"STRAT/AUD",
         "rate": 111.111
         "amount":111.1111,
         "created":"2020-05-21T13:22:45.000Z",
         "type": "take profit"
      }}
   ]
}

My Order History

Url

Root: https://www.coinspot.com.au/api/v2/ro
Request /my/orders/completed

Inputs

cointype - (optional) coin short name, example value 'BTC', 'LTC', 'DOGE'
markettype - (optional, available markets only) market coin short name, example values 'AUD', 'USDT'
startdate - (optional, note: date is UTC date or UNIX EPOCH time) format 'YYYY-MM-DD' or e.g. 1614824116
enddate - (optional, note: date is UTC date or UNIX EPOCH time) format 'YYYY-MM-DD' or e.g. 1614824116
limit - (optional, default is 200 records, max is 500 records)

Response

status - ok, error
message - ok, description of error if error occurred
buyorders - array containing your buy order history
sellorders - array containing your sell order history

Example response

{
   "status":"ok",
   "message":"ok",
   "buyorders":[
      {
      	 "id": "1f1f1f1f1d1d1d1d1d1d1d1d",
         "coin":"STRAT",
         "type":"market",
         "market":"STRAT/AUD",
         "rate":1222.33,
         "amount":111.1111,
         "total":222.2222,
         "solddate":"2020-05-21T13:22:45.000Z",
         "audfeeExGst":45.11111,
         "audGst":40.11111,
         "audtotal":444444
      },
      {
    	 "id": "1f1f1f1f1d1d1d1d1d1d1d1d",
         "coin":"STRAT",
         "type":"instant",
         "otc":false,
         "market":"OMG/AUD",
         "rate":1222.33,
         "amount":333.33333,
         "total":222.2222,
         "solddate":"2020-05-21T13:22:45.000Z",
         "audfeeExGst":44.444444,
         "audGst":4.444444,
         "audtotal":5000
      }]
   "sellorders":[
     {
      	 "id": "1f1f1f1f1d1d1d1d1d1d1d1d",
         "coin":"STRAT",
         "type":"market",
         "market":"STRAT/AUD",
         "rate":1222.33,
         "amount":111.1111,
         "total":222.2222,
         "solddate":"2020-05-21T13:22:45.000Z",
         "audfeeExGst":45.11111,
         "audGst":40.11111,
         "audtotal":444444
      },
      {
      	 "id": "1f1f1f1f1d1d1d1d1d1d1d1d",
         "coin":"STRAT",
         "type":"instant",
         "otc":false,
         "market":"STR/AUD",
         "rate":1222.33,
         "amount":333.33333,
         "total":222.2222,
         "solddate":"2020-05-21T13:22:45.000Z",
         "audfeeExGst":44.444444,
         "audGst":4.444444,
         "audtotal":5000
      }]
   ]
}

My Market Order History

Url

Root: https://www.coinspot.com.au/api/v2/ro
Request /my/orders/market/completed

Inputs

Note: Default start time period is 24 hrs ago

Response

status - ok, error
message - ok, description of error if error occurred
buyorders - array containing your buy order history
sellorders - array containing your sell order history

Example response

{
   "status":"ok",
   "message":"ok",
   "buyorders":[
      {
      	 "id": "1f1f1f1f1d1d1d1d1d1d1d1d",
         "coin":"STRAT",
         "market":"STRAT/AUD",
         "rate":1222.33,
         "amount":111.1111,
         "total":222.2222,
         "solddate":"2020-05-21T13:22:45.000Z",
         "audfeeExGst":45.11111,
         "audGst":40.11111,
         "audtotal":444444
      },
      {
      	 "id": "1f1f1f1f1d1d1d1d1d1d1d1d",
         "coin":"STRAT",
         "market":"OMG/AUD",
         "rate":1222.33,
         "amount":333.33333,
         "total":222.2222,
         "solddate":"2020-05-21T13:22:45.000Z",
         "audfeeExGst":44.444444,
         "audGst":4.444444,
         "audtotal":5000
      }]
   "sellorders":[
     {
      	 "id": "1f1f1f1f1d1d1d1d1d1d1d1d",
         "coin":"STRAT",
         "market":"STRAT/AUD",
         "rate":1222.33,
         "amount":111.1111,
         "total":222.2222,
         "solddate":"2020-05-21T13:22:45.000Z",
         "audfeeExGst":45.11111,
         "audGst":40.11111,
         "audtotal":444444
      },
      {
      	 "id": "1f1f1f1f1d1d1d1d1d1d1d1d",
         "coin":"STRAT",
         "market":"OMG/AUD",
         "rate":1222.33,
         "amount":333.33333,
         "total":222.2222,
         "solddate":"2020-05-21T13:22:45.000Z",
         "audfeeExGst":44.444444,
         "audGst":4.444444,
         "audtotal":5000
      }]
   ]
}

My Send & Receive History

Url

Root: https://www.coinspot.com.au/api/v2/ro
Request /my/sendreceive

Inputs

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

Response

status - ok, error
message - ok, description of error if error occurred
sendtransactions - array containing your coin send transaction history
receivetransactions - array containing your coin receive transaction history

Example response

{
   "status":"ok",
   "message":"ok",
   "sendtransactions":[
      {
         "timestamp":"2020-05-21T13:22:45.000Z",
         "amount":1.111,
         "coin":"ETH",
         "address":"12345678901234567890",
         "aud": 0.123,
         "sendfee:0.002",
      },
      {
         "timestamp":"2020-05-21T13:22:45.000Z",
         "amount":1111.11111,
         "coin":"NFT|||0x12345f64363bd663abd3ef08df75dd22d853111|||1234",
         "address":"12345678901234567890",
         "aud": 0,
         "sendfee:0",
      }
   ],
   "receivetransactions":[
	{
         "timestamp":"2020-05-21T13:22:45.000Z",
         "amount":1.111,
         "coin":"ETH",
         "address":"12345678901234567890",
         "aud": 0.123,
         "from": "rKPEmdyitW5Lm7VhFDxDgMjEvUF7kqcEgj"
      },
    {
         "timestamp":"2020-05-21T13:22:45.000Z",
         "amount":0.11111,
         "coin":"BTC",
         "address":"12345678901234567890",
         "aud": 0,
         "from": "user@domain.com"
      }
   ]
}

My Deposit History

Url

Root: https://www.coinspot.com.au/api/v2/ro
Request /my/deposits

Inputs

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

Response

status - ok, error
message - ok, description of error if error occurred
deposits - array containing your AUD deposit history

Example response

"status":"ok",
   "message":"ok",
   "deposits":[
      {
         "amount":1111,
         "created":""2020-05-21T13:22:45.000Z",
         "status":"completed",
         "type":"PayID",
         "reference":"12345678901234567890"
      },
      {
         "amount":2000,
         "created":"2020-05-21T13:22:45.000Z",
         "status":"completed",
         "type":"PayID",
         "reference":"12345678901234567890"
      }
   ]
}

My Withdrawal History

Url

Root: https://www.coinspot.com.au/api/v2/ro
Request /my/withdrawals

Inputs

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

Response

status - ok, error
message - ok, description of error if error occurred
withdrawals - array containing your AUD withdrawal history

Example response

{
   "status":"ok",
   "message":"ok",
   "withdrawals":[
      {
         "amount":10,
         "created":"2020-05-21T13:22:45.000Z",
         "status":"created"
      },
      {
         "amount":20,
         "created":"2020-05-21T13:22:45.000Z",
         "status":"created"
      }
   ]
}

My Affiliate Payments

Url

Root: https://www.coinspot.com.au/api/v2/ro
Request /my/affiliatepayments

Inputs

none

Response

status - ok, error
message - ok, description of error if error occurred
payments - array containing one object for each completed affiliate payment

Example response

{
   "status":"ok",
   "message":"ok",
   "payments":[
      {
         "amount":111.1111,
         "month":"2020-05-21T13:22:45.000Z"
      },
      {
         "amount":111.1111,
         "month":"2020-04-21T13:22:45.000Z"
      }
   ]
}

My Referral Payments

Url

Root: https://www.coinspot.com.au/api/v2/ro
Request /my/referralpayments

Inputs

none

Response

status - ok, error
message - ok, description of error if error occurred
payments - array containing one object for each completed referral payment

Example response

{
   "status":"ok",
   "message":"ok",
   "payments":[
      {
         "amount":111.1111,
         "coin":"BTC",
         "audamount":10,
         "timestamp":"2020-04-21T13:22:45.000Z"
      },
      {
         "amount":222.22222,
         "coin":"BTC",
         "audamount":10,
         "timestamp":"2020-05-21T13:22:45.000Z"
      }
   ]
}

CoinSpot API V2 (BETA)

Headers

Post Params

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url

Inputs

Response

Example response

Url