Download OpenAPI specification:Download
Welcome to Bitaroo API Docs.
Please note that older endpoints are V1, while newer ones are V2.
To generate your API Key, please go to 'Account' --> 'API Keys' and follow the instructions there.
Your API Key consists of two parts: the Key ID and the secret, displayed as "KeyID.secret".
The secret part is securely encrypted, making it inaccessible to both you and us after its initial presentation.
It will be shown to you only once, upon key creation, and never again.
Returns the current orderbook
Array of objects non-empty unique | |
Array of objects non-empty unique |
{- "buy": [
- {
- "price": "46313.99",
- "amount": "0.070006"
}, - {
- "price": "46303.94",
- "amount": "0.070006"
}, - {
- "price": "46282.77",
- "amount": "0.0149646"
}
], - "sell": [
- {
- "price": "46442.7",
- "amount": "0.09038535"
}, - {
- "price": "46476.45",
- "amount": "0.0707"
}, - {
- "price": "46545.07",
- "amount": "0.06458026"
}
]
}
Returns a list of recent trades
tradeId | number |
price | string non-empty |
amount | string non-empty |
takerSide | string non-empty |
timestamp | number |
[- {
- "tradeId": 432248,
- "price": "51951.01",
- "amount": "0.00001632",
- "takerSide": "sell",
- "timestamp": 1623815232000
}, - {
- "tradeId": 432247,
- "price": "52090.38",
- "amount": "0.00038321",
- "takerSide": "buy",
- "timestamp": 1623814741000
}
]
Returns the deposits of the account
fy required | integer Financial year |
asset | string Asset to return (aud/btc) |
depositId | integer non-empty |
assetSymbol | string non-empty |
amount | string non-empty |
fee | string |
wosId | string |
status | string non-empty |
ref | string |
timestamp | string non-empty |
[- {
- "depositId": 2,
- "assetSymbol": "aud",
- "amount": "300",
- "fee": "4.95",
- "wosId": null,
- "status": "declined",
- "ref": null,
- "timestamp": "2024-01-19T10:04:09.000Z"
}, - {
- "depositId": 1,
- "assetSymbol": "aud",
- "amount": "1.5",
- "fee": "0",
- "wosId": null,
- "status": "processed",
- "ref": null,
- "timestamp": "2024-01-19T10:04:09.000Z"
}
]
Returns the withdrawals of the account
fy required | integer Financial year |
asset | string Asset to return (aud/btc) |
withdrawalId | integer non-empty |
assetSymbol | string non-empty |
amount | string non-empty |
fee | string |
name | string |
bsb | string |
account | string |
payId | string |
address | string |
wosId | string |
priority | string |
status | string non-empty |
ref | string |
timestamp | string non-empty |
[- {
- "withdrawalId": 27,
- "assetSymbol": "btc",
- "amount": "0.0001",
- "fee": "0.0001",
- "name": null,
- "bsb": null,
- "account": null,
- "payId": null,
- "address": "36UgQmHjUainV6B7HV58vmV3gAc1w3Rurt",
- "wosId": null,
- "priority": "eco",
- "status": "processed",
- "ref": null,
- "timestamp": "2023-11-17T09:18:09.000Z"
}, - {
- "withdrawalId": 12,
- "assetSymbol": "aud",
- "amount": "20",
- "fee": "1.95",
- "name": "Bitaroo",
- "bsb": "123-123",
- "account": "0998998",
- "payId": null,
- "address": null,
- "wosId": null,
- "priority": null,
- "status": "processed",
- "ref": "12",
- "timestamp": "2023-11-03T12:17:46.000Z"
}
]
Returns the balances of the account
balance | string non-empty |
locked | string non-empty |
assetSymbol | string non-empty |
available | string non-empty |
[- {
- "balance": "0.0065",
- "locked": "0",
- "assetSymbol": "btc",
- "available": "0.0065"
}, - {
- "balance": "30",
- "locked": "4.99",
- "assetSymbol": "aud",
- "available": "25.01"
}
]
Returns recent trades. If the orderId parameter is given, only trades for this order are returned, else recent trades
orderId | integer Order to get trades for |
recordId | number |
tradeId | number |
orderId | number Order the trade belongs to |
side | string non-empty buy/sell |
price | string non-empty |
amount | string non-empty |
fee | string non-empty |
role | string non-empty 'self', 'maker', 'taker' |
timestamp | number |
[- {
- "recordId": 854187,
- "tradeId": 427113,
- "orderId": 82369604,
- "side": "sell",
- "price": "46983.94",
- "amount": "0.00063832",
- "fee": "-0.00899723657424",
- "role": "maker",
- "timestamp": 1623068521103
}
]
Generate a new Lightning deposit invoice
amount | string |
{- "amount": "0.00002121"
}
lnbc21210n1psd86mupp5q4kpp7lxua06xvu4p7kudaswkqhe9u9vtur5s05x0f23ucwx3m0sdqcgf5hgctjdahjq3r9wphhx6t5cqzpgxqyz5vqsp5z0hju4jeux7kkg56259xzdtf3taxyyk09eexuupve7eyks44hr6s9qyyssqw4e7hhgcjagy7uvsps7wp08f76utp2rlygdpppw9e0nlgth5hl3394xza73jv3qmt2psre0p6lwmdvm303p6wvyc6sfjx332l2lq56sqdhk68z
BTC/AUD withdrawal. To see if your account is eligible for activation, please contact support
symbol required | string aud or btc |
amount required | string |
required | object |
success | boolean non-empty |
withdrawalId | integer non-empty |
amount | string non-empty |
ref | string non-empty |
{- "symbol": "aud",
- "amount": "500",
- "destination": {
- "bsb": "123456",
- "account": "123456789"
}
}
{- "success": true,
- "withdrawalId": 3,
- "amount": "300",
- "ref": "111111"
}
Creates a new order
orderType required | string 'market' or 'limit' |
side required | string 'buy' or 'sell' |
price | string |
amount required | string |
hidden | boolean Optional for 'limit'. Can be used with 'gtc' or 'moc' only. Default: false |
tif | string Optional for 'limit'. Can be one of: 'gtc', 'ioc', 'fok' or 'moc' |
orderId | number |
{- "orderType": "limit",
- "side": "buy",
- "price": "50000",
- "amount": "0.1234",
- "hidden": false,
- "tif": "gtc"
}
{- "orderId": 82640842
}
Returns a list of recent orders. All query parameters are optional and mutually exclusive.
orderId | number Order to return |
activeOnly | boolean Return only active orders |
historyOnly | boolean Return only recent in-active orders |
orderId | number Order ID |
side | string non-empty Side of the order, valid values: 'buy' or 'sell' |
orderType | string non-empty Type of order, valid types: 'market' or 'limit' |
price | string non-empty Price for the order |
amount | string non-empty Amount of BTC |
tif | string non-empty |
hidden | boolean |
takerFee | number |
makerFee | number |
stopOrderId | any |
dcaOrderId | any |
filled | string non-empty Amount of BTC filled |
cancelled | boolean |
timestamp | number |
status | string non-empty |
[- {
- "orderId": 1,
- "side": "sell",
- "orderType": "limit",
- "price": "100816.58",
- "amount": "0.00100000",
- "tif": "gtc",
- "hidden": false,
- "takerFee": 0.03,
- "makerFee": -0.03,
- "stopOrderId": null,
- "dcaOrderId": null,
- "filled": "0",
- "cancelled": false,
- "timestamp": 1618232431000,
- "status": "open"
}
]