API | CoinSpot

<!doctype html> <html lang="en"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta property="og:image" content="https://www.coinspot.com.au/public/img/coinspot-sml-white.png"> <meta property="og:image:type" content="image/png"> <meta property="og:image:width" content="480"> <meta property="og:image:height" content="480"> <title>API | CoinSpot</title> <link rel="shortcut icon" href="/public/img/favicon.png?v=401"> <link rel="apple-touch-icon" sizes="57x57" href="/public/img/favicons/apple-icon-57x57.png"> <link rel="apple-touch-icon" sizes="60x60" href="/public/img/favicons/apple-icon-60x60.png"> <link rel="apple-touch-icon" sizes="72x72" href="/public/img/favicons/apple-icon-72x72.png"> <link rel="apple-touch-icon" sizes="76x76" href="/public/img/favicons/apple-icon-76x76.png"> <link rel="apple-touch-icon" sizes="114x114" href="/public/img/favicons/apple-icon-114x114.png"> <link rel="apple-touch-icon" sizes="120x120" href="/public/img/favicons/apple-icon-120x120.png"> <link rel="apple-touch-icon" sizes="144x144" href="/public/img/favicons/apple-icon-144x144.png"> <link rel="apple-touch-icon" sizes="152x152" href="/public/img/favicons/apple-icon-152x152.png"> <link rel="apple-touch-icon" sizes="180x180" href="/public/img/favicons/apple-icon-180x180.png"> <link rel="icon" type="image/png" sizes="192x192" href="/public/img/favicons/android-icon-192x192.png"> <link rel="icon" type="image/png" sizes="32x32" href="/public/img/favicons/favicon-32x32.png"> <link rel="icon" type="image/png" sizes="96x96" href="/public/img/favicons/favicon-96x96.png"> <link rel="icon" type="image/png" sizes="16x16" href="/public/img/favicons/favicon-16x16.png"> <link rel="manifest" href="/public/img/favicons/manifest.json"> <meta name="msapplication-TileColor" content="#ffffff"> <meta name="msapplication-TileImage" content="/public/img/favicons/ms-icon-144x144.png"> <meta name="theme-color" content="#ffffff"> <link rel="stylesheet" href="/public/css/coinspot.min.css?v=401"> <script nonce="2daba5b435ccbbc96042bad275aa043d" src="/public/js/coinspot.min.js?v=401"></script> <script nonce="2daba5b435ccbbc96042bad275aa043d" src="/public/js/brhash.min.js?v=401"></script> <script nonce="2daba5b435ccbbc96042bad275aa043d" src="/public/js/bootstrap-sortable.js?v=401"></script> <link rel="stylesheet" type="text/css" href="/public/icons/flaticon.css?v=401"> <link rel="stylesheet" type="text/css" href="/public/css/font.css?v=401"> <link rel="stylesheet" href="/public/css/pages/main.css?v=401"> <link rel="stylesheet" href="/public/css/v2.css?v=401"> <style> </style> <script nonce="2daba5b435ccbbc96042bad275aa043d" src="/public/js/pages/main.js?v=401"></script> </head> <body> <header class="navbar navbar-default navbar-static-top bs-docs-nav" id="top" role="banner"> <div class='container page-content-body'> <style> .not-menu { width: 550px; padding: 20px; } .not-header { color: #75798A; font-size: 16px; font-family: "InterSmBd"; } .not-header a { font-size: 12px; } .not-tabs { margin-top: 20px; margin-bottom: 20px; font-family: "Inter"; } .not-tabs-2 { margin-top: 10px; } .not-tabs .nav { display: flex; margin-bottom: 20px; } .not-tabs .nav li { flex: 1; text-align: center; border: solid 1px #E2E3E9; border-right: 0; margin: 0; } .not-tabs .nav-pills>li.active>a { background-color: #CCDDFF !important; color: #0049DB !important; } .not-tabs .nav li:last-child { border: solid 1px #E2E3E9; border-radius: 0 5px 5px 0 !important; } .not-tabs .nav li:first-child { border: solid 1px #E2E3E9; border-radius: 5px 0 0 5px !important; border-right: 0; } .not-tabs .not-count { background-color: #CD4741; color: white; margin-left: 10px; border-radius: 4px !important; padding: 2px; padding-left: 5px; padding-right: 5px; float: right; font-family: "Circular Std Book"; font-size: 10px; min-width: 18px; text-align: center; } .not-content { overflow: auto; -webkit-overflow-scrolling: touch; height: 500px; } .not-content-row h5 { color: #181A20; font-size: 14px; margin-top: 5px; } .not-content-row { color: #6E7591; font-family: "Inter"; border-bottom: solid 1px #E2E3E9; padding: 10px 10px 10px 10px; cursor: pointer; background-color: #fbfbfb; } .not-content-row.not-unread { background-color: #fff; cursor: pointer; border-radius: 5px !important; } .not-content-row.not-unread[data-important=true] .not-close { display: none; } .not-content-row.not-unread .not-link { display: none; } .not-content-row .not-close { float: right; font-size: 12px; } .not-content-row h5 .not-alert { background: #CD4741; width: 12px; height: 12px; border-radius: 50% !important; display: inline-block; margin-right: 10px; } .not-content-row .not-time { font-size: 12px; padding-bottom: 5px; } .not-content-row .not-text-trunc { white-space: nowrap; overflow: hidden; text-overflow: ellipsis; max-width: 15ch; } .not-no-notifications { color: #333; } .shorten { white-space: nowrap; overflow: hidden; text-overflow: ellipsis; max-width: 15ch; } .not-content-row .not-link { padding-top: 10px; font-size: 14px; } .navbar .container { background-color: #004FEE; } .navbar-default .navbar-nav>li>a.standard-menu { border-bottom: solid 2px #004FEE; } .nav.navbar-nav.navbar-right { border-bottom: solid 2px #004FEE; } .nav-menu li { display: inline-block; width: calc(50% - 2px); margin-bottom: 10px; xheight: 62px; } .nav-menu>li>a { line-height: 2em !important; font-weight: 800; font-family: "Mont"; font-size: 11.5px; text-transform: uppercase; } .nav-menu>li>a .dropdown-subtitle { color: #ACAEB9; font-weight: 400; text-transform: none; } .nav-menu>li>a:hover { } .nav-arrow { line-height: 60px; } .dropdown-menu li .nav-arrow i[class^="flaticon-"]:before, .dropdown-menu li .nav-arrow i[class*=" flaticon-"]:before { font-size: 16px !important; color: #ACAEB9; } .nav-menu li:first-child { width: 100%; } .dropdown-menu>li>a { line-height: 3em; } .dropdown-menu>li>a.dropdown-header { cursor:default; } .dropdown-menu>li>a.dropdown-header:hover { background-color: white; } .dropdown-menu>li>a>img { height: 24px; margin-right: 10px; } .dropdown-menu>li>a>svg { margin-right: 10px; } .notification-menu .notification-count { text-align: center; background: red; color: white; padding-left: 5px; padding-right: 5px; border-radius: 30% !important; font-size: 12px; display: none; float: right; height: 16px; line-height: 16px; margin-top: 0px; position: absolute; font-size: 10px; top: 5px; right: -5px; } .notification-menu .notification-count.notification-read { background: rgba(0, 0, 0, .45); } .not-text pre { border: none; background-color: transparent; font-family: Inter !important; color: #6E7591; font-size: 14px; padding: 0; margin: 0; white-space: pre-wrap; word-break: normal; } .notification-important { position: absolute; top: 2px; right: -5px; height: 20px; } @media (max-width: 991px) { .notification-menu .notification-count { top: 12px; right: 5px; } .notification-menu .notification-important { right: 5px; } .not-tabs { margin: 0; } } @media (max-width: 1000px) { .not-tabs .nav { display: block; } .navbar-header { float: none; } .navbar-left,.navbar-right { float: none !important; } .navbar-toggle { display: block; margin-right: 0px; } .navbar-collapse { border-top: 1px solid transparent; box-shadow: inset 0 1px 0 rgba(255,255,255,0.1); } .navbar-fixed-top { top: 0; border-width: 0 0 1px; } .navbar-collapse.collapse { display: none!important; } .navbar-nav { float: none!important; margin-top: 7.5px; } .navbar-nav>li { float: none; } .navbar-nav>li>a { padding-top: 10px; padding-bottom: 10px; } .collapse.in{ display:block !important; } } .account-icon:before { top: 0 !important; font-size: 20px; } .account-arrow:before { top: -3px !important; font-size: 12px; } .open > .dropdown-menu { animation-name: slidenavAnimation; animation-duration:.3s; animation-iteration-count: 1; animation-timing-function: ease; animation-fill-mode: forwards; -webkit-animation-name: slidenavAnimation; -webkit-animation-duration:.3s; -webkit-animation-iteration-count: 1; -webkit-animation-timing-function: ease; -webkit-animation-fill-mode: forwards; -moz-animation-name: slidenavAnimation; -moz-animation-duration:.3s; -moz-animation-iteration-count: 1; -moz-animation-timing-function: ease; -moz-animation-fill-mode: forwards; } @keyframes slidenavAnimation { from { opacity: 0; } to { opacity: 1; } } @-webkit-keyframes slidenavAnimation { from { opacity: 0; } to { opacity: 1; } } </style> <div class='innercontainer'> <div class="navbar-header"> <button class="pull-right navbar-toggle sidenav-toggle collapsed navbar-menu-button" style='margin-top:12px' type="button"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar" style='background-color:#fff'></span> <span class="icon-bar" style='background-color:#fff'></span> <span class="icon-bar icon-bar-small" style='background-color:#fff'></span> </button> <a class="pull-right btn-header login-btn userlogin" style="color:#FFE; margin-top:12px" href="/login">LOGIN</a> <a class="col-md-push-1 navbar-brand" style='padding-top: 19px;' href="/"><img src='/public/img/coinspot-logo.svg?v=401' alt='CoinSpot' style='margin-top:-5px;margin-right:5px;height:30px;width:30px'/> CoinSpot</a> </div> <nav class="navbar-collapse bs-navbar-collapse collapse" role="navigation" style="height: 1px;"> <ul class="nav navbar-nav navbar-right" style='margin-right:0px'> <li><a href='/' class='home-menu'>Home</a></li> <li><a href="/multicoinwallets" class='wallets-menu'>Wallets</a></li> <li><a href='/tradecoins' class='buysell-menu'>Buy/Sell</a></li> <li><a href='/swap' class='swap-menu'>Swap</a></li> <li><a href='/bundles' class='bundles-menu'>Bundles</a></li> <li><a href='/nft' class='nft-menu'>NFT</a></li> <li><a href='/otc' class='otc-menu'>OTC</a></li> <li><a href='/markets' class='markets-menu'>Markets</a></li> <li class="register-link"><a href='/register' class="btn-header hidden-xs">Register</a></li> <li><a href='/register' class="hidden-sm hidden-md hidden-lg">Register</a></li> <li class="home-login-link"><a href='/login' class="btn-header hidden-xs">Login</a></li> <li><a href='/login' class="hidden-sm hidden-md hidden-lg">Login</a></li> </ul> </nav> </div> <div class='sidenav-overlay sidenav-overlay-1'></div> <nav id='notificationnav' class='hidden not-tabs' role='navigation'> <div class="not-header">Notifications <a href="/my/messagecenter" class="pull-right">View All</a> </div> <div class="not-tabs-2"></div> </nav> <div class='sidenav-overlay sidenav-overlay-2'></div> <nav id='sidenav' class='hidden' role='navigation'> <div class='sidenav-header'> <img src='/public/img/logo-horz-ondark.png?v=401' alt='CoinSpot' style='height:35px' /> </div> <ul class="list-unstyled"> <li><a href="/"><i class="flaticon-home"></i>HOME</a></li> <li><a href="/multicoinwallets"><span><i class="flaticon-money"></i>WALLETS</span></a></li> <li><a href="/tradecoins"><i class="flaticon-buy"></i>BUY / SELL</a></li> <li><a href="/swap"><i class="flaticon-exchange"></i>SWAP</a></li> <li><a href="/bundles"><i class="flaticon-bills"></i>BUNDLES</a></li> <li><a href="/nft"><i class="flaticon-buy"></i>NFT</a></li> <li><a href="/otc"><i class="flaticon-scales"></i>OTC</a></li> <li><a href="/markets"><i class="flaticon-bar-chart"></i>MARKETS</a></li> </ul> <ul class="list-unstyled pt-40 pb-50"> <li><a href="/register"><i class="flaticon-rocket"></i>REGISTER</a></li> <li><a href="/login"><i class="flaticon-log-out"></i>LOGIN</a></li> <li><a href="https://coinspot.zendesk.com/hc/en-us" target="_blank" class='chat'><i class="flaticon-speech-bubble-1"></i>SUPPORT</a></li> </ul> </nav> <script nonce="2daba5b435ccbbc96042bad275aa043d"> $('.sidenav-toggle, .sidenav-overlay-2').click(function (e) { $('#sidenav').toggleClass('hidden'); $('.sidenav-overlay-2').toggle(); $('body').toggleClass('vh-100'); e.stopPropagation(); }) $('#account-dropdown-menu').on('shown.bs.dropdown', function () { $('.nav-menu').width(550); //$('.dropdown-toggle.account-menu').width($('.navbar-nav>li>.dropdown-menu').width()-20); }) $('#account-dropdown-menu').on('hide.bs.dropdown', function () { $('.dropdown-toggle.account-menu').width(0); }) $(document).on('click', '.notification-toggle, .sidenav-overlay-1', function () { $('#notificationnav').toggleClass('hidden'); $('.sidenav-overlay-1').toggle(); $('body').toggleClass('vh-100'); getmessageslist_menu('not-tabs-2'); return false; }); $(document).on('click', '.dropdown-menu.not-menu a[data-toggle="tab"]', function (e) { e.stopPropagation() $(this).tab('show'); return false; }) $(document).on('click', '#notificationnav a[data-toggle="tab"]', function (e) { e.stopPropagation() $(this).tab('show'); return false; }) $(document).on('click', '.not-content-row a', function (e, y) { e.stopPropagation() return true; }) $(document).on('click', '.not-content-row', function (e, y) { var id = $(this).attr('data-id'); var tab = $(this).attr('data-tab'); markmessageasread_menu(id, tab); return false; }) $(document).on('click', '.not-close', function (e, y) { var id = $(this).attr('data-id'); var tab = $(this).attr('data-tab'); markmessageasclose_menu(id, tab); return false; }) function showalerts(count, important) { $('.notification-menu .notification-count').addClass('notification-read'); $('.notification-menu .notification-count').html(count); if (count > 0) $('.notification-menu .notification-count').removeClass('notification-read'); $('.notification-menu .notification-important').hide(); $('.notification-menu .notification-count').hide(); if (important) $('.notification-menu .notification-important').show(); else $('.notification-menu .notification-count').show(); if (count <= 0) $('.notification-menu .notification-count').hide(); } showalerts(('' || 0), '' == 'true'); function getmessages_menu() { $.get('/my/messagecenter/count', function (data) { // not availble on route if (typeof data == "string") return; if (data && data.ok && data.result) { showalerts(data.result.count, data.result.hasimportant) } setTimeout(getmessages_menu, 10000); }) } getmessages_menu(); var tabcounts = {}; function markmessageasread_menu(id, tab) { var alreadyread = !$('.not-content-row[data-id=' + id + ']').hasClass('not-unread'); $('.not-content-row[data-id=' + id + ']').removeClass('not-unread'); $('.not-content-row[data-id=' + id + ']').find('.not-text').removeClass('not-unread'); $('.not-content-row[data-id=' + id + ']').find('.not-text pre').toggleClass('not-text-trunc'); $('.not-content-row[data-id=' + id + ']').find('.not-link').toggleClass('hidden'); if (alreadyread) return; var unread = tabcounts[tab].ucount; if (unread > 0) tabcounts[tab].ucount = unread - 1; if (tabcounts[tab].ucount > 0) { var ucounttext = tabcounts[tab].ucount; if (ucounttext > 5) ucounttext = "5+"; $('li[data-tab="' + tab + '"] span').html(ucounttext); } else { $('li[data-tab="' + tab + '"] span').remove(); } $.post('/my/messagecenter/markread', { id: id }) } function markmessageasclose_menu(id, tab) { $('.not-content-row[data-id=' + id + ']').hide(300); if ($('.not-content-row.not-unread[data-id=' + id + ']').length) { var unread = tabcounts[tab].ucount; if (unread > 0) tabcounts[tab].ucount = unread - 1; if (tabcounts[tab].ucount > 0) { var ucounttext = tabcounts[tab].ucount; if (ucounttext > 5) ucounttext = "5+"; $('li[data-tab="' + tab + '"] span').html(ucounttext); } else { $('li[data-tab="' + tab + '"] span').remove(); } } $.post('/my/messagecenter/remove', { id: id }) } $('#notification-dropdown-menu').on('shown.bs.dropdown', function () { getmessageslist_menu('not-tabs-1'); }) function getmessageslist_menu(container) { $.get('/my/messagecenter/preview', function (data) { if (data && data.ok && data.result) { return showmessageslist_menu(data.result, container); } $('.' + container).html("Error retrieving notifications"); }) } function showmessageslist_menu(data, container) { var tabs = Object.keys(data); tabs.sort(function (a, b) { if (data[a].tab < data[b].tab) { return -1; } if (data[a].tab > data[b].tab) { return 1; } return 0; }); var tabsHtml = ``; $.each(tabs, function (i, item) { var count = ''; var plus = ''; tabcounts[item] = { rcount: data[item].rcount, ucount: data[item].ucount } if (data[item].hasmore) plus = '+'; if (data[item].msgs.length) count = `<span class='not-count'>${data[item].msgs.length}${plus}</span>`; if (i == 0) tabsHtml += `<li class="active" data-tab="${item}"><a data-toggle="tab" href="#tab_${i}_${container}">${item}${count}</a></li>`; else tabsHtml += `<li data-tab="${item}"><a data-toggle="tab" href="#tab_${i}_${container}">${item}${count}</a></li>`; }) var contentHtml = ''; $.each(tabs, function (i, item) { var items = data[item].msgs; var rowHtml = ''; $.each(items, function (x, row) { var link = ''; var important = ''; var unread = ''; if (row.hdomain) { var target = ''; if (row.newtab) target = ' target="_blank" '; link = `<div class="not-link hidden"><a ${target} href="https://${row.hdomain}${row.hpath}">${row.htext}</a></div>` } if (row.important) { important = '<img style="height:24px" src="/public/img/warning.svg" />'; } if (row.unread) { unread = 'not-unread'; } var closelink = `<a href='#' data-id='${row._id}' data-tab='${item}' class='not-close'><i class='flaticon flaticon-close'></i></a>`; rowHtml += ` <div class="not-content-row ${unread}" data-important="${row.important}" data-tab="${item}" data-id="${row._id}"> ${closelink} <h5>${important}${row.title}</h5> <div class="not-time">${row.activated}</div> <div class="not-text" data-id="${row._id}"><pre class="not-text-trunc">${row.body}</pre>${link}</div> </div>`; }) if (!rowHtml) rowHtml = '<div style="padding: 10px;" class="not-no-notifications">There are no unread notifications.</div>' if (i == 0) contentHtml += `<div id="tab_${i}_${container}" class="tab-pane in active">${rowHtml}</div>`; else contentHtml += `<div id="tab_${i}_${container}" class="tab-pane">${rowHtml}</div>`; }); $('.' + container).html(`<ul class="nav nav-pills">${tabsHtml}</ul><div class='tab-content'>${contentHtml}</div>`); } </script> </div> </header> <div id='about' class='container page-content-body'> <div class="page-header"> <h1>CoinSpot API V2 (BETA)<small> </small></h1> <div id="topdiv"></div> </div> <div class='row'> <div class='col-md-12'> <div class='col-md-3'> <div class="panel fixed"> <div class='panel-heading'> Contents </div> <div class='panel-body'> <ul class="nav nav-pills nav-stacked"> <li><a class='navitem' href="#security">Security</a></li> <li><a class='navitem' href="#sdk">SDK</a></li> </ul> </div> <div class='panel-heading nounderline'> Public API<br> </div> <div class='panel-body'> <ul class="nav nav-pills nav-stacked"> <li><a class='navitem' href="#latestprices">Latest Prices</a></li> <li><a class='navitem' href="#latestpricescoin">Latest Coin Prices</a></li> <li><a class='navitem' href="#latestpricescoinmarket">Latest Coin / Market Prices</a></li> <li><a class='navitem' href="#latestbuyprice">Latest Buy Price</a></li> <li><a class='navitem' href="#latestbuypricenonfiat">Latest Buy Price / Market</a></li> <li><a class='navitem' href="#latestsellprice">Latest Sell Price</a></li> <li><a class='navitem' href="#latestsellpricenonfiat">Latest Sell Price / Market</a></li> <li><a class='navitem' href="#openorders">Open Orders By Coin</a></li> <li><a class='navitem' href="#openordersmarket">Open Orders By Coin / Market</a></li> <li><a class='navitem' href="#historders">Completed Orders By Coin</a></li> <li><a class='navitem' href="#histordersmarket">Completed Orders By Coin / Market</a></li> <li><a class='navitem' href="#historderssumm">Completed Orders By Coin (Summary Only)</a></li> <li><a class='navitem' href="#histordersmarketsumm">Completed Orders By Coin / Market (Summary Only)</a></li> </ul> </div> <div class='panel-heading nounderline'> API<br> </div> <div class='panel-body'> <ul class="nav nav-pills nav-stacked"> <li><a class='navitem' href="#apistatus">Full Access Status Check</a></li> <li><a class='navitem' href="#deposit">My Coin Deposit Address</a></li> <li><a class='navitem' href="#buynowquote">Buy Now Quote</a></li> <li><a class='navitem' href="#sellnowquote">Sell Now Quote</a></li> <li><a class='navitem' href="#swapnowquote">Swap Now Quote</a></li> <li><a class='navitem' href="#placebuyorder">Place Market Buy Order</a></li> <li><a class='navitem' href="#editbuyorder">Edit Open Market Buy Order</a></li> <li><a class='navitem' href="#placebuynoworder">Place Buy Now Order</a></li> <li><a class='navitem' href="#placesellorder">Place Market Sell Order</a></li> <li><a class='navitem' href="#editsellorder">Edit Open Market Sell Order</a></li> <li><a class='navitem' href="#placesellnowrder">Place Sell Now Order</a></li> <li><a class='navitem' href="#placeswapnoworder">Place Swap Now Order</a></li> <li><a class='navitem' href="#cancelbuyorder">Cancel My Buy Order</a></li> <li><a class='navitem' href="#cancelbuyorderall">Cancel My Buy Orders All</a></li> <li><a class='navitem' href="#cancelsellorder">Cancel My Sell Order</a></li> <li><a class='navitem' href="#cancelsellorderall">Cancel My Sell Orders All</a></li> <li><a class='navitem' href="#cointihdetail">Get Coin Withdrawal Details</a></li> <li><a class='navitem' href="#coinsend">Coin Withdrawal</a></li> </ul> </div> <div class='panel-heading'> Read Only API </div> <div class='panel-body'> <ul class="nav nav-pills nav-stacked"> <li><a class='navitem' href="#rostatus">Read Only Status Check</a></li> <li><a class='navitem' href="#apiopenorders">Open Market Orders</a></li> <li><a class='navitem' href="#apihistorders"> Completed Market Orders</a></li> <li><a class='navitem' href="#romybalances">My Coin Balances</a></li> <li><a class='navitem' href="#rocoinsbalance">My Coin Balance (Available)</a></li> <li><a class='navitem' href="#roopenmarketorders">My Open Market Orders</a></li> <li><a class='navitem' href="#roopenlimitorders">My Open Limit Orders</a></li> <li><a class='navitem' href="#roorders">My Order History</a></li> <li><a class='navitem' href="#rotransaction">My Market Order History</a></li> <li><a class='navitem' href="#rosendreceive">My Send & Receive History</a></li> <li><a class='navitem' href="#rodeposit">My Deposit History</a></li> <li><a class='navitem' href="#rowithdrawal">My Withdrawal History</a></li> <li><a class='navitem' href="#roaffpay">My Affiliate Payments</a></li> <li><a class='navitem' href="#rorefpay">My Referral Payments</a></li> </ul> </div> </div> </div> <div class="col-md-9"> <div class="panel"> <div class='panel-heading'> Legacy API (V1) Still Active At This Stage </div> <div class="panel-body"> <p><b>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.</b></p> <p>If required, documentation for the old (V1) API is available <a href="/api">here.</a></p> </div> </div> <div class="panel"> <div class='panel-heading'> V2 Summary </div> <div class="panel-body"> <p> This page provides basic documentation on using the CoinSpot API. </p> <p> 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: <a href="https://www.coinspot.com.au/my/api">https://www.coinspot.com.au/my/api</a>. 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 <a href='/register'>register here</a>. </p> <p> <b>Important things to note</b> <br> All requests and responses will be JSON format <br> All response date and time values will be in UTC format e.g. 2020-05-21T13:22:45.000Z <br> All requests will be made with the GET method for the Public API and POST method for all other API requests. <br> All requests will return a <b>200</b> http status code if successful, any other status code received indicates request failure and a <b>message</b> value in the response will describe the issue encountered.</b> <br> Requests are limited to 1000 requests per minute.</b> <br><br> The endpoint for the Public API is <b>https://www.coinspot.com.au/pubapi/v2</b> <br> The endpoint for the API is <b>https://www.coinspot.com.au/api/v2</b> <br> </p> <p> <b>Read Only API</b> <br> There is also a Read Only API available, you can read the <a href="#rosummary">documentation for the read only API here.</a><br> The endpoint for the Read Only API is <b>https://www.coinspot.com.au/api/v2/ro</b> <br> </p> <b>Example error response</b> <p>All errors returned will contain an error status and a message that describes the issue encountered</p> <p><pre> { "status":"error", "message":"Coin not found" }</pre></p> </div> </div> <div class="panel" id='security'> <div class='panel-heading'> <div class='step-icon'>Security <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> 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. </p> <p> All requests to the POST API requests will need to include the following security data. </p> <p> <h4>Headers</h4> <b>key</b> - Your API key generated from the settings page<br> <b>sign</b> - The POST data is to be signed using your secret key according to HMAC-SHA512 method. <br> </p> <p> <h4>Post Params</h4> <b>nonce</b> - Any integer value which must always be greater than the previous requests nonce value. </p> </div> </div> <div class="panel" id='sdk'> <div class='panel-heading'> <div class='step-icon'>SDK <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> We currently have a node.js SDK, if you are interested in getting an SDK in another language <a href="/contact" data-uv-trigger="contact"> please contact us</a> </p> <p> <b>node.js</b> - <a href='https://www.npmjs.org/package/coinspot-api'>https://www.npmjs.org/package/coinspot-api</a> </p> </div> </div> <div class="panel" id='latestprices'> <div class='panel-heading'> <div class='step-icon'>Latest Prices <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>https://www.coinspot.com.au/pubapi/v2/latest</b> </p> <p> <h4>Inputs</h4> <b>none</b> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>prices</b> - 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' <br> </p> <h4>Example response</h4> <p><pre> { "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 } } }</pre></p> </div> </div> <div class="panel" id='latestpricescoin'> <div class='panel-heading'> <div class='step-icon'>Latest Coin Prices <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>https://www.coinspot.com.au/pubapi/v2/latest/{cointype}</b> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>prices</b> - object with set of properties for coin with latest buy, ask and last prices <br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "prices":{ "bid":11111, "ask":222222, "last":1111.11 } }</pre></p> </div> </div> <div class="panel" id='latestpricescoinmarket'> <div class='panel-heading'> <div class='step-icon'>Latest Coin / Market Prices <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>https://www.coinspot.com.au/pubapi/v2/latest/{cointype}/{markettype}</b> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>markettype</b> - market coin short name, example value 'USDT' (only for available markets)<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>prices</b> - object with set of properties for coin with latest buy, ask and last prices <br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "prices":{ "bid":11111, "ask":222222, "last":1111.11 } }</pre></p> </div> </div> <div class="panel" id='latestbuyprice'> <div class='panel-heading'> <div class='step-icon'>Latest Buy Price <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>https://www.coinspot.com.au/pubapi/v2/buyprice/{cointype}</b> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>rate</b> - latest buy price for that coin<br> <b>market</b> - market coin is trading in<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "rate":11111, "market": "BTC/AUD" }</pre></p> </div> </div> <div class="panel" id='latestbuypricenonfiat'> <div class='panel-heading'> <div class='step-icon'>Latest Buy Price / Market <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>https://www.coinspot.com.au/pubapi/v2/buyprice/{cointype}/{markettype}</b> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>markettype</b> - coin market you wish to use to buy it, example value: USDT' (only for available markets)<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>rate</b> - latest buy price for that coin<br> <b>market</b> - market coin is trading in<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "rate":11111, "market": "BTC/USDT" }</pre></p> </div> </div> <div class="panel" id='latestsellprice'> <div class='panel-heading'> <div class='step-icon'>Latest Sell Price <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>https://www.coinspot.com.au/pubapi/v2/sellprice/{cointype}</b> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>rate</b> - latest sell price for that coin<br> <b>market</b> - market coin is trading in<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "rate":11111, "market": "BTC/AUD" }</pre></p> </div> </div> <div class="panel" id='latestsellpricenonfiat'> <div class='panel-heading'> <div class='step-icon'>Latest Sell Price / Market <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>https://www.coinspot.com.au/pubapi/v2/sellprice/{cointype}/{markettype}</b> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>markettype</b> - coin market you wish to sell it for, example value: 'USDT' (note: only for available markets)<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>rate</b> - latest sell price for that coin<br> <b>market</b> - market coin is trading in<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "rate":11111, "market": "BTC/USDT" }</pre></p> </div> </div> <div class="panel" id='openorders'> <div class='panel-heading'> <div class='step-icon'>Open Orders By Coin <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>https://www.coinspot.com.au/pubapi/v2/orders/open/{cointype}</b> </p> <p> <h4>Inputs</h4> <b>cointype</b> - the coin short name, example value 'BTC', 'LTC', 'DOGE'<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>buyorders</b> - list of top 100 open AUD buy orders for the given coin <br> <b>sellorders</b> - list of top 100 open AUD sell orders for the given coin <br> </p> <h4>Example response</h4> <p><pre> { "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" } ] }</pre></p> </div> </div> <div class="panel" id='openordersmarket'> <div class='panel-heading'> <div class='step-icon'>Open Orders By Coin / Market <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>https://www.coinspot.com.au/pubapi/v2/orders/open/{cointype}/{markettype}</b> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>markettype</b> - coin market, example values 'USDT' (note: only for available markets)<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>buyorders</b> - list of top 20 open buy order rates for the given coin / market <br> <b>sellorders</b> - list of top 20 open sell order rates for the given coin / market <br> </p> <h4>Example response</h4> <p><pre> { "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", } ] }</pre></p> </div> </div> <div class="panel" id='historders'> <div class='panel-heading'> <div class='step-icon'>Completed Orders By Coin <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>https://www.coinspot.com.au/pubapi/v2/orders/completed/{cointype}</b> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>buyorders</b> - list of top 100 completed AUD buy orders for the given coin <br> <b>sellorders</b> - list of top 100 completed AUD sell orders for the given coin <br> </p> <h4>Example response</h4> <p><pre> { "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", } ] }</pre></p> </div> </div> <div class="panel" id='histordersmarket'> <div class='panel-heading'> <div class='step-icon'>Completed Orders By Coin / Market <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>https://www.coinspot.com.au/pubapi/v2/orders/completed/{cointype}/{markettype}</b> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>markettype</b> - coin market, example values 'USDT' (note: only for available markets)<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>buyorders</b> - list of top 100 completed buy orders for the given coin / market <br> <b>sellorders</b> - list of top 100 completed sell orders for the given coin / market <br> </p> <h4>Example response</h4> <p><pre> { "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", } ] }</pre></p> </div> </div> <div class="panel" id='historderssumm'> <div class='panel-heading'> <div class='step-icon'>Completed Orders By Coin (Summary Only) <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>https://www.coinspot.com.au/pubapi/v2/orders/summary/completed/{cointype}</b> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>orders</b> - list of top 100 completed AUD orders for the given coin - not separated into buy/sell orders <br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "orders":[ { "amount":0.1, "rate":111111, "total":111111, "coin":"BTC", "solddate":"2020-05-21T13:22:45.000Z", "market":"BTC/AUD", }, ], }</pre></p> </div> </div> <div class="panel" id='histordersmarketsumm'> <div class='panel-heading'> <div class='step-icon'>Completed Orders By Coin / Market (Summary Only) <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>https://www.coinspot.com.au/pubapi/v2/orders/summary/completed/{cointype}/{markettype}</b> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>markettype</b> - coin market, example values 'USDT' (note: only for available markets)<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>orders</b> - list of top 100 completed orders for the given coin / market - not separated into buy/sell orders <br> </p> <h4>Example response</h4> <p><pre> { "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", }, ], }</pre></p> </div> </div> <div class="panel" id='apistatus'> <div class='panel-heading'> <div class='step-icon'>Full Access Status Check <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /status<br> </p> <p> <h4>Inputs</h4> <b>none</b><br> </p> <p> <h4>Response</h4> <b>status</b> - ok<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok" }</pre></p> </div> </div> <div class="panel" id='deposit'> <div class='panel-heading'> <div class='step-icon'>My Coin Deposit Address <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /my/coin/deposit<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> coin short name, example value 'BTC', 'LTC', 'DOGE'<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>networks</b> - list of available networks (fields below)<br><br> <b>name</b> - network name<br> <b>network</b> - network type<br> <b>address</b> - your deposit address for the coin<br> <b>memo</b> - your memo / tag for the coin (where required)<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "networks": [ {"name": "BEP2", "network": "BNB", "address": "bnbabcdef123456abcdef123456", "memo": "123456"}, {"name": "ERC20", "network": "ETH", "address": "0xabcdef123456abcdef123456", "memo": ""} ] }</pre></p> </div> </div> <div class="panel" id='buynowquote'> <div class='panel-heading'> <div class='step-icon'>Buy Now Quote <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /quote/buy/now<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>amount</b> - amount to buy<br> <b>amounttype</b> - 'coin' or 'aud' - whether the amount above is coin amount or AUD amount<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>rate</b> - rate per specified coin<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "rate":1111 }</pre></p> </div> </div> <div class="panel" id='sellnowquote'> <div class='panel-heading'> <div class='step-icon'>Sell Now Quote <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /quote/sell/now<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>amount</b> - amount of coins to sell<br> <b>amounttype</b> - 'coin' or 'aud' - whether the amount below is coin amount or AUD amount<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>rate</b> - rate per specified coin inclusive of fee<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "rate":11111 }</pre></p> </div> </div> <div class="panel" id='swapnowquote'> <div class='panel-heading'> <div class='step-icon'>Swap Now Quote <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /quote/swap/now<br> </p> <p> <h4>Inputs</h4> <b>cointypesell</b> - coin short name you would like to swap, example value 'BTC', 'LTC', 'DOGE'<br> <b>cointypebuy</b> - coin short name you wuld like to swap it for, example value 'BTC', 'LTC', 'DOGE'<br> <b>amount</b> - amount of coins to swap<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>rate</b> - rate per coin swapped exclusive of fee<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "rate":11111 }</pre></p> </div> </div> <div class="panel" id='placebuyorder'> <div class='panel-heading'> <div class='step-icon'>Place Market Buy Order <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /my/buy<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>amount</b> - mount of coins you want to buy, max precision 8 decimal places<br> <b>rate</b> - rate in market currency (e.g. AUD or USDT) you are willing to pay, max precision 8 decimal places<br> <b>markettype</b> - (<i>optional, available markets only, default 'AUD'</i>) market coin short name to use to buy the coin, example value 'USDT'<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>coin</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>market</b> - market used to place buy order for the coin<br> <b>amount</b> - coin amount that was placed<br> <b>rate</b> - rate that order was placed at<br> <b>id</b> - id of buy order created which can be used to cancel the order if desired </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "coin":"BTC", "market": "BTC/AUD", "amount":1.234 "rate":123.344 "id":"12345678901234567890" }</pre></p> </div> </div> <div class="panel" id='editbuyorder'> <div class='panel-heading'> <div class='step-icon'>Edit Open Market Buy Order <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /my/buy/edit<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>id</b> - order id of the target buy order<br> <b>rate</b> - current rate in market currency (e.g. AUD or USDT) of the open order, max precision 8 decimal places<br> <b>newrate</b> - proposed rate in market currency (e.g. AUD or USDT) to edit the open order, max precision 8 decimal places<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <h4>(on success)</h4> <b>updated</b> - true<br> <b>coin</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>rate</b> - new rate that order has been placed at<br> <b>newrate</b> - requested rate<br> <b>amount</b> - coin amount calculated as a result of the rate adjustment<br> <b>total</b> - total is not adjusted from original order<br> <b>id</b> - id of the edited buy order (unchanged) </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "id":"12345678901234567890" "coin":"BTC", "rate": "1234556", "newrate": "1234556", "amount":1.234, "total": 1234, "updated": true }</pre></p> </div> </div> <div class="panel" id='placebuynoworder'> <div class='panel-heading'> <div class='step-icon'>Place Buy Now Order <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /my/buy/now<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>amounttype</b> - 'coin' or 'aud' - whether the amount below is coin amount or AUD amount<br> <b>amount</b> - amount to buy, max precision for coin is 8 decimal places and 2 decimal places for AUD<br> <br><i>Optional</i><br> <b> Note 1:</b> if rate option below is submitted a threshold value must also be submitted<br> <b> Note 2:</b> buy will occur at current rate not submitted rate <br><br> <b>rate</b> - (optional) rate in AUD received from using Buy Now Quote or otherwise <br> <b>threshold</b> - (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<br><br> <b>direction</b> - (optional) UP, DOWN, or BOTH (default is UP) - direction the price has moved for the percentage threshold to apply <br><br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>coin</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>market</b> - market used to place buy order for the coin<br> <b>amount</b> - amount that was bought<br> <b>total</b> - total amount in market currency<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "coin":"BTC", "amount":1.234, "market":"BTC/AUD", "total": 10.234 }</pre></p> </div> </div> <div class="panel" id='placesellorder'> <div class='panel-heading'> <div class='step-icon'>Place Market Sell Order <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /my/sell<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>amount</b> - amount of coins you want to sell, max precision 8 decimal places<br> <b>rate</b> - rate in AUD you are willing to sell for, max precision 8 decimal places<br> <b>markettype</b> - (<i>optional, available markets only, default 'AUD'</i>) market coin short name to use to sell the coin into, example value 'USDT'<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>coin</b> - coin short name<br> <b>market</b> - market used to place sell order for the coin<br> <b>amount</b> - coin amount that was placed in order<br> <b>rate</b> - rate that order was placed at<br> <b>id</b> - id of sell order created which can be used to cancel the order if desired </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "coin":"BTC", "market": "BTC/AUD", "amount":1.234, "rate":123.344, "id":"12345678901234567890" }</pre></p> </div> </div> <div class="panel" id='editsellorder'> <div class='panel-heading'> <div class='step-icon'>Edit Open Market Sell Order <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /my/sell/edit<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>id</b> - order id of the target sell order<br> <b>rate</b> - current rate in market currency (e.g. AUD or USDT) of the open order, max precision 8 decimal places<br> <b>newrate</b> - proposed rate in market currency (e.g. AUD or USDT) to edit the open order, max precision 8 decimal places<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <h4>(on success)</h4> <b>updated</b> - true<br> <b>coin</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>rate</b> - new rate that order has been placed at<br> <b>newrate</b> - requested rate<br> <b>amount</b> - amount is not adjusted from original order<br> <b>total</b> - total calculated as a result of the rate adjustment<br> <b>id</b> - id of the edited sell order (unchanged) </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "id":"12345678901234567890", "coin":"BTC", "rate": "1234556", "newrate": "1234556", "amount": 1234, "total":1.234, "updated": true }</pre></p> </div> </div> <div class="panel" id='placesellnowrder'> <div class='panel-heading'> <div class='step-icon'>Place Sell Now Order <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /my/sell/now<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>amounttype</b> - 'coin' or 'aud' - whether the amount below is coin amount or AUD amount<br> <b>amount</b> - amount of coins you want to sell, max precision 8 decimal places<br> <br><i>Optional</i><br> <b> Note 1:</b> if rate option below is submitted a threshold value must also be submitted<br> <b> Note 2:</b> sell will occur at current rate not submitted rate <br><br> <b>rate</b> - (optional) rate in AUD received from using Sell Now Quote or otherwise <br> <b>threshold</b> - (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<br><br> <b>direction</b> - (optional) UP, DOWN, or BOTH (default is DOWN) - direction the price has moved for the percentage threshold to apply <br><br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>coin</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>market</b> - market used to place sell order for the coin<br> <b>amount</b> - amount that was sold<br> <b>rate</b> - rate that order was placed at<br> <b>total</b> - total amount in market currency<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "coin":"BTC", "amount":1.234, "rate":3.234, "market":"BTC/AUD", "total": 10.234 }</pre></p> </div> </div> <div class="panel" id='placeswapnoworder'> <div class='panel-heading'> <div class='step-icon'>Place Swap Now Order <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /my/swap/now<br> </p> <p> <h4>Inputs</h4> <b>cointypesell</b> - coin short name you would like to swap, example value 'BTC', 'LTC', 'DOGE'<br> <b>cointypebuy</b> - coin short name you wuld like to swap it for, example value 'BTC', 'LTC', 'DOGE'<br> <b>amount</b> - amount of (cointypesell) to swap, max precision for coin is 8 decimal places<br> <br><i>Optional</i><br> <b> Note 1:</b> if rate option below is submitted a threshold value must also be submitted<br> <b> Note 2:</b> swap will occur at current rate not submitted rate <br><br> <b>rate</b> - (optional) rate received from using Swap Now Quote or otherwise <br> <b>threshold</b> - (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<br><br> <b>direction</b> - (optional) UP, DOWN, or BOTH (default is BOTH) - direction the price has moved for the percentage threshold to apply <br><br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>coin</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>market</b> - coin swapped and and coin it was swapped for <br> <b>amount</b> - coin amount that was swapped<br> <b>rate</b> - rate that order was placed at<br> <b>total</b> - total amount in swapped coin currency<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "coin":"BTC", "amount":1.234, "rate":3.234, "market":"BTC/ETH", "total": 10.234 }</pre></p> </div> </div> <div class="panel" id='cancelbuyorder'> <div class='panel-heading'> <div class='step-icon'>Cancel My Buy Order <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /my/buy/cancel<br> </p> <p> <h4>Inputs</h4> <b>id</b> - id of the buy order to cancel<br><br> <b>Note:</b> '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<br><br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok" }</pre></p> </div> </div> <div class="panel" id='cancelbuyorderall'> <div class='panel-heading'> <div class='step-icon'>Cancel My Buy Orders All <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /my/buy/cancel/all<br> </p> <p> <h4>Inputs</h4> <b>coin</b> - (optional) coin of the buy orders to cancel<br><br> <b>Note:</b> '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<br><br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok" }</pre></p> </div> </div> <div class="panel" id='cancelsellorder'> <div class='panel-heading'> <div class='step-icon'>Cancel My Sell Order <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /my/sell/cancel<br> </p> <p> <h4>Inputs</h4> <b>id</b> - id of the sell order to cancel<br><br> <b>Note:</b> '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<br><br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok" }</pre></p> </div> </div> <div class="panel" id='cancelsellorderall'> <div class='panel-heading'> <div class='step-icon'>Cancel My Sell Orders All <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /my/sell/cancel/all<br> </p> <p> <h4>Inputs</h4> <b>coin</b> - (optional) coin of the sell orders to cancel<br><br> <b>Note:</b> '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<br><br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok" }</pre></p> </div> </div> <div class="panel" id='cointihdetail'> <div class='panel-heading'> <div class='step-icon'>Get Coin Withdrawal Details <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <b><i>NOTE: ** This function must be ENABLED via the API key options available when logged in at <a href='https://www.coinspot.com.au/my/api'>https://www.coinspot.com.au/my/api</a></i></b><br><br> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /my/coin/withdraw/senddetails<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name you would like to withdraw, example value 'BTC', 'LTC', 'DOGE'<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>networks</b> - list of available send networks<br><br> </p> <h4>Example response</h4> <b>NOTE: network details are subject to change, please check occasionally </b> <p><pre> { "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}, ] }</pre></p> </div> </div> <div class="panel" id='coinsend'> <div class='panel-heading'> <div class='step-icon'>Coin Withdrawal <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <b><i>NOTE: ** This function must be ENABLED via the API key options available when logged in at <a href='https://www.coinspot.com.au/my/api'>https://www.coinspot.com.au/my/api</a></i></b><br><br> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2<br> <b>Request</b> /my/coin/withdraw/send<br> </p> <p> <h4>Inputs</h4> <b>NOTE: for network and paymentid details please see 'Get Coin Withdrawal Details' above </b><br><br> <b>cointype</b> - coin short name you would like to withdraw, example values 'BTC', 'LTC', 'DOGE'<br> <b>amount</b> - the amount (in coin currency) of coin you would like to withdraw<br> <b>address</b> - the destination address for the coin amount'<br> <b>emailconfirm</b> - (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'<br> <b>network</b> - (optional) - network you would like to send using e.g. 'BNB', 'ETH' - omit for 'default' network<br> <b>paymentid</b> - (optional) - the appropriate payment id/memo for the withdrawal where permitted<br><br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> </p><br> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok" }</pre></p> </div> </div>  <div class="panel" id="rosummary"> <div class='panel-heading' > Read Only API </div> <div class="panel-body"> <p> We have a <b>Read Only API</b> available. <br> To use this API, you need to generate a Read Only API key from the settings page. </p> <p> <b>Important things to note about the read only API</b> <br> All requests and responses will be JSON. <br> All requests will be made with the POST method. <br><br> The endpoint for the Read Only API is <b>https://www.coinspot.com.au/api/v2/ro</b> <br> </p> </div> </div> <div class="panel" id='rostatus'> <div class='panel-heading'> <div class='step-icon'>Read Only Status Check <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2/ro<br> <b>Request</b> /status<br> </p> <p> <h4>Inputs</h4> <b>none</b><br> </p> <p> <h4>Response</h4> <b>status</b> - ok<br> </p> <h4>Example response</h4> <p><pre> { "status":"ok" }</pre></p> </div> </div> <div class="panel" id='apiopenorders'> <div class='panel-heading'> <div class='step-icon'>Open Market Orders <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2/ro<br> <b>Request</b> /orders/market/open<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>markettype</b> - (<i>optional, available markets only)</i>) market coin short name, example values 'AUD', 'USDT'<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>buyorders</b> - list of top 20 open buy order rates for the given coin <br> <b>sellorders</b> - list of top 20 open sell orders rates for the given coin <br> </p> <h4>Example response</h4> <p><pre> { "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" } ] },</pre></p> </div> </div> <div class="panel" id='apihistorders'> <div class='panel-heading'> <div class='step-icon'>Completed Market Orders <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2/ro<br> <b>Request</b> /orders/market/completed<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>markettype</b> - (<i>optional, available markets only)</i>) market coin short name, example values 'AUD', 'USDT'<br> <b>startdate</b> - (optional, note: date is UTC date or UNIX EPOCH time) format 'YYYY-MM-DD' or e.g. 1614824116<br> <b>enddate</b> - (optional, note: date is UTC date or UNIX EPOCH time) format 'YYYY-MM-DD' or e.g. 1614824116<br> <b>limit</b> - (optional, default is 200 records, max is 500 records) </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>buyorders</b> - list of top 100 completed buy orders for the given coin <br> <b>sellorders</b> - list of top 100 completed sell orders for the given coin <br> </p> <h4>Example response</h4> <p><pre> { "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 } ] },</pre></p> </div> </div> <div class="panel" id='romybalances'> <div class='panel-heading'> <div class='step-icon'>My Coin Balances <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2/ro<br> <b>Request</b> /my/balances<br> </p> <p> <h4>Inputs</h4> <b>none</b><br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>balances</b> - array containing one object for each coin with your balance, AUD value and rate for that coin<br> </p> <h4>Example response</h4> <p><pre> { "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 } }] }</pre></p> </div> </div> <div class="panel" id='rocoinsbalance'> <div class='panel-heading'> <div class='step-icon'>My Coin Balance (Available) <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2/ro<br> <b>Request</b> /my/balance/{cointype}?available={yes/no}<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> - coin short name, example value 'AUD', 'BTC', 'LTC', 'DOGE'<br> <b>available</b> - 'yes' or 'no', yes to return available balance in addition to actual balance </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>balance</b> - object containing property with your actual/available balance, AUD value (actual balance) and rate for that coin<br><br> <b>(note: available balance will be included in response if available option is set to 'yes')</b><br><br> </p> <h4>Example response</h4> <p><pre> { "status":"ok", "message":"ok", "balance":{ "EOS":{ "balance":1.11111, "available": 0.99999, "audbalance": 222.22, "rate": 1.11111 } } }</pre></p> </div> </div> <div class="panel" id='roopenmarketorders'> <div class='panel-heading'> <div class='step-icon'>My Open Market Orders <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2/ro<br> <b>Request</b> /my/orders/market/open<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> - (optional) coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>markettype</b> - (optional) market coin short name, example value 'USDT', 'AUD'<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>buyorders</b> - array containing your open buy orders<br> <b>sellorders</b> - array containing your open sell orders<br> </p> <h4>Example response</h4> <p><pre> { "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 }} ] }</pre></p> </div> </div> <div class="panel" id='roopenlimitorders'> <div class='panel-heading'> <div class='step-icon'>My Open Limit Orders <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2/ro<br> <b>Request</b> /my/orders/limit/open<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> - (optional) coin short name, example value 'BTC', 'LTC', 'DOGE'<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>buyorders</b> - array containing your open buy orders<br> <b>sellorders</b> - array containing your open sell orders<br> </p> <h4>Example response</h4> <p><pre> { "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" }} ] }</pre></p> </div> </div> <div class="panel" id='roorders'> <div class='panel-heading'> <div class='step-icon'>My Order History <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2/ro<br> <b>Request</b> /my/orders/completed<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> - (optional) coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>markettype</b> - (optional, available markets only) market coin short name, example values 'AUD', 'USDT'<br> <b>startdate</b> - (optional, note: date is UTC date or UNIX EPOCH time) format 'YYYY-MM-DD' or e.g. 1614824116<br> <b>enddate</b> - (optional, note: date is UTC date or UNIX EPOCH time) format 'YYYY-MM-DD' or e.g. 1614824116<br> <b>limit</b> - (optional, default is 200 records, max is 500 records) </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>buyorders</b> - array containing your buy order history<br> <b>sellorders</b> - array containing your sell order history<br> </p> <h4>Example response</h4> <p><pre> { "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 }] ] }</pre></p> </div> </div> <div class="panel" id='rotransaction'> <div class='panel-heading'> <div class='step-icon'>My Market Order History <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2/ro<br> <b>Request</b> /my/orders/market/completed<br> </p> <p> <h4>Inputs</h4> <b>cointype</b> - (optional) coin short name, example value 'BTC', 'LTC', 'DOGE'<br> <b>markettype</b> - (optional, available markets only) market coin short name, example values 'AUD', 'USDT'<br> <b>startdate</b> - (optional, note: date is UTC date or UNIX EPOCH time) format 'YYYY-MM-DD' or e.g. 1614824116<br> <b>enddate</b> - (optional, note: date is UTC date or UNIX EPOCH time) format 'YYYY-MM-DD' or e.g. 1614824116<br> <b>limit</b> - (optional, default is 200 records, max is 500 records) <br><br> <p><i>Note: Default start time period is 24 hrs ago</i></p><br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>buyorders</b> - array containing your buy order history<br> <b>sellorders</b> - array containing your sell order history<br> </p> <h4>Example response</h4> <p><pre> { "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 }] ] }</pre></p> </div> </div> <div class="panel" id='rosendreceive'> <div class='panel-heading'> <div class='step-icon'>My Send & Receive History <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2/ro<br> <b>Request</b> /my/sendreceive<br> </p> <p> <h4>Inputs</h4> <b>startdate</b> - (optional) format 'YYYY-MM-DD'<br> <b>enddate</b> - (optional) format 'YYYY-MM-DD'<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>sendtransactions</b> - array containing your coin send transaction history<br> <b>receivetransactions</b> - array containing your coin receive transaction history<br> </p> <h4>Example response</h4> <p><pre> { "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" } ] }</pre></p> </div> </div> <div class="panel" id='rodeposit'> <div class='panel-heading'> <div class='step-icon'>My Deposit History <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2/ro<br> <b>Request</b> /my/deposits<br> </p> <p> <h4>Inputs</h4> <b>startdate</b> - (optional) format 'YYYY-MM-DD'<br> <b>enddate</b> - (optional) format 'YYYY-MM-DD'<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>deposits</b> - array containing your AUD deposit history<br> </p> <h4>Example response</h4> <p><pre> "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" } ] }</pre></p> </div> </div> <div class="panel" id='rowithdrawal'> <div class='panel-heading'> <div class='step-icon'>My Withdrawal History <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2/ro<br> <b>Request</b> /my/withdrawals<br> </p> <p> <h4>Inputs</h4> <b>startdate</b> - (optional) format 'YYYY-MM-DD'<br> <b>enddate</b> - (optional) format 'YYYY-MM-DD'<br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>withdrawals</b> - array containing your AUD withdrawal history<br> </p> <h4>Example response</h4> <p><pre> { "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" } ] }</pre></p> </div> </div> <div class="panel" id='roaffpay'> <div class='panel-heading'> <div class='step-icon'>My Affiliate Payments <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2/ro<br> <b>Request</b> /my/affiliatepayments<br> </p> <p> <h4>Inputs</h4> <b>none</b><br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>payments</b> - array containing one object for each completed affiliate payment<br> </p> <h4>Example response</h4> <p><pre> { "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" } ] }</pre></p> </div> </div> <div class="panel" id='rorefpay'> <div class='panel-heading'> <div class='step-icon'>My Referral Payments <a href="#topdiv"><i class="flaticon-up-arrow"></i></a></div> </div> <div class="panel-body"> <p> <h4>Url</h4> <b>Root:</b> https://www.coinspot.com.au/api/v2/ro<br> <b>Request</b> /my/referralpayments<br> </p> <p> <h4>Inputs</h4> <b>none</b><br> </p> <p> <h4>Response</h4> <b>status</b> - ok, error<br> <b>message</b> - ok, description of error if error occurred<br> <b>payments</b> - array containing one object for each completed referral payment<br> </p> <h4>Example response</h4> <p><pre> { "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" } ] }</pre></p> </div> </div>  </div> </div> </div> </div> <style> .page-content { background: #fff; padding: 0px;} .nounderline { border-bottom: 0px} </style> <footer class='v2 py-50 ' role="contentinfo"> <div class='container'> <div class='grid'> <div class='d-none d-lg-block col-lg-2'> <div class='mt-20' style='white-space: nowrap'> <a class='footer-logo' href="/"><img src='/public/img/coinspot-logo.svg?v=401' alt='CoinSpot' />CoinSpot</a> </div> <div class='footer-adcca mt-20'> <a href='https://blockchainaustralia.org/member/member-profile-coinspot/' target='_blank' rel='nofollow'> <img src="/public/img/adcca-industry.png?v=401" alt="adcca industry certified" style="max-width:160px"> <div class='footer-text'>Member since: 02.02.2014</div> </a> </div> <div class='footer-iso mt-30'> <a href='https://coinspot.zendesk.com/hc/en-us/articles/360001428615' target='_blank' rel='nofollow'> <div> <img style="width:100%" src="/public/img/iso27001.png?v=401"> </div> <div class='footer-text text-center'> Certified since: 13.02.2020 </div> </a> </div> </div> <div class='col-6 col-md-4 col-lg-2'> <ul class='footer-group'> <li class='footer-group-title'>PRODUCTS</li> <li><a href='/buy/btc'>Buy Bitcoin</a></li> <li><a href='/trade/btc'>Bitcoin Trading</a></li> <li><a href='/tradecoins'>Instant Buy/Sell</a></li> <li><a href='/swap'>Instant Swap</a></li> <li><a href='/markets'>CoinSpot Markets</li> <li><a href='/bundles'>CoinSpot Bundles</a></li> <li><a href='/card'>CoinSpot Mastercard</a></li> <li><a href='/nft'>Buy NFTs</a></li> <li><a href='/defi'>Buy & Sell DeFi Projects</a></li> <li><a href='/nfts'>Buy & Sell NFT Projects</a></li> <li><a href='/multicoinwallets'>Multicoin Wallets</a></li> <li><a href='/otc'>Over the Counter (OTC)</a></li> <li><a href='/smsf'>Self Managed Super (SMSF)</a></li> <li><a href='/v2/api'>API</a></li> <li><a href='/mobile'>CoinSpot App</a></li> <li> <a href='' class="setnightmodebtn btn btn-default toggle"> <i class="flaticon-moon-1"></i> Night </a> </li> </ul> </div> <div class='col-6 col-md-4 col-lg-2'> <ul class='footer-group'> <li class='footer-group-title'>ABOUT</li> <li><a href='/security'>Security</a></li> <li><a href='/tradesafely'>Trade Safely With CoinSpot</li> <li><a href='/press'>Press Enquiries</a></li> <li><a href='/fees'>Fees</a></li> <li><a href='/terms'>Terms of Use</a></li> <li><a href='/privacy'>Privacy Policy</a></li> <li><a href='/aml'>AML</a></li> </ul> </div> <div class='col-6 col-md-4 col-lg-2'> <ul class='footer-group mb-30'> <li class='footer-group-title'>EARN</li> <li><a href='/affiliate'>Affiliate Program</a></li> <li><a href='/referrals'>Referral Program</a></li> </ul> <ul class='footer-group d-none d-lg-block'> <li class='footer-group-title'>COMMUNITY</li> <li><a href='https://www.facebook.com/coinspotau/' target='_blank' rel='nofollow'>Facebook</a></li> <li><a href='https://twitter.com/coinspotau/' target="_blank" rel='nofollow'>Twitter</a></li> <li><a href='https://www.instagram.com/coinspot/' target="_blank" rel='nofollow'>Instagram</a></li> <li><a href='https://www.reddit.com/r/coinspotau/' target="_blank" rel='nofollow'>Reddit</a></li> </ul> </div> <div class='col-6 col-md-4 col-lg-2'> <ul class='footer-group'> <li class='footer-group-title'>LEARN</li> <li><a href='/learn'>Learn with CoinSpot</a></li> <li><a href='/bitcoinhalving'>Bitcoin Halving</a></li> <li><a href='/how-to-buy-bitcoin'>How to buy Bitcoin</a></li> <li><a href='/how-to-buy-ethereum-in-australia'>How to buy Ethereum</a></li> <li><a href='/cryptotax'>Cryptocurrency & Tax</a></li> </ul> </div> <div class='d-lg-none col-6 col-md-4 col-lg-2'> <ul class='footer-group'> <li class='footer-group-title'>COMMUNITY</li> <li><a href='https://www.facebook.com/coinspotau/' target='_blank' rel='nofollow'>Facebook</a></li> <li><a href='https://twitter.com/coinspotau/' target="_blank" rel='nofollow'>Twitter</a></li> <li><a href='https://www.instagram.com/coinspot/' target="_blank" rel='nofollow'>Instagram</a></li> <li><a href='https://www.reddit.com/r/coinspotau/' target="_blank" rel='nofollow'>Reddit</a></li> </ul> </div> <div class='col-6 col-md-4 col-lg-2'> <ul class='footer-group'> <li class='footer-group-title'>SUPPORT</li> <li><a target="_blank" href='https://coinspot.zendesk.com/hc/en-us'>Help Centre</a></li> <li><a href='/contact'>Contact Support</a></li> <li><a href='/accountrecovery/email'>Account Recovery</a></li> <li><a target='_blank' href='https://coinspot.zendesk.com/hc/en-us/articles/115001019874'>Complaints & Disputes</a></li> <li><a target="_blank" href='https://coinspot.zendesk.com/hc/en-us/articles/333757066344'>Protect Yourself Online</a></li> <li><a href='/requestacoin'>Request a Coin</a></li> <li><a href='/feedback'>Feedback</a></li> </ul> </div> </div> <div class='d-lg-none'> <div class='mt-20' style='white-space: nowrap'> <a class='footer-logo' href="/"><img src='/public/img/coinspot-logo.svg?v=401' alt='CoinSpot' />CoinSpot</a> </div> <div class='d-flex mt-10'> <div> <a href='https://blockchainaustralia.org/member/member-profile-coinspot/' target='_blank' rel='nofollow'> <img src="/public/img/adcca-industry.png?v=401" alt="adcca industry certified" style="max-width:160px"><br> <span class='footer-text'>Member since: 02.02.2014</span> </a> </div> <div class='footer-iso ml-10 ml-sm-30'> <a href='https://coinspot.zendesk.com/hc/en-us/articles/360001428615' target='_blank' rel='nofollow'> <div> <img style="max-width:150px" src="/public/img/iso27001.png?v=401"> </div> <div class='footer-text text-center'> Certified since: 13.02.2020 </div> </a> </div> </div> </div> </div> <style> .toggle { border-radius: 5px !important; border-width: 2px; background-color: transparent; margin-top: 10px; padding: 3px 6px; min-width: auto; } .toggle:hover { min-width: auto; } </style> <script nonce="2daba5b435ccbbc96042bad275aa043d"> $(function() { var now = new Date(new Date().getTime() - (1000 * 60 * 60)); function getAffiliate() { var regex = new RegExp("[\\?&]affiliate=([^&#]*)"), results = regex.exec(location.search); return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " ")); } var affiliate = getAffiliate(); if (!affiliate) return; if (typeof affiliate != "string") return; var regex = new RegExp("^(?=.*[0-9])[A-Za-z0-9]+$") if (!regex.test(affiliate)) return; if (affiliate.length > 10) affiliate = affiliate.slice(0, 10).trim(); var date = new Date(); date.setTime(date.getTime() + (7 * 24 * 60 * 60 * 1000)); document.cookie = "affiliate=" + affiliate + '; expires=' + date.toUTCString(); + '; path=/'; //remove referral cookie document.cookie = 'referralcode=;expires=Thu, 01 Jan 1970 00:00:01 GMT;'; }) $('.setdaymodebtn').click(function() { setCookie('nightmode', 'false', 10000); }) $('.setnightmodebtn').click(function() { setCookie('nightmode', 'true', 10000); location.reload(); }) </script> </footer> <img style='position:absolute; bottom:0;' src='https://d.adroll.com/ipixel/N4TJSFRVCFGKRDAMHEW4HL/H2ZYWXYBNJBYTDMNOZTAXU?name=4bb0f946' width='1px' height='1px' /> </body> </html>

CINXE.COM

API | CoinSpot