GET /GetAssets
No Authorization Required
Read Permission
DESCRIPTION
Returns all available coin assets and their information.
EXAMPLE REQUEST URL:
https://www.oodlebit.com/api/v1/getassets
RESPONSE EXAMPLE (200 OK):
{
"Success": true,
"Message": "",
"Result": [
{
"AssetId": 1,
"Name": "BTC",
"Description": "Bitcoin"
}
]
}
GET /GetAssetPairs
No Authorization Required
Read Permission
DESCRIPTION
Returns all available asset pairs and their information.
REQUEST PARAMETERS
(optional)BaseAssetId:integer
(optional)QuoteAssetId:integer
EXAMPLE REQUEST URL:
https://www.oodlebit.com/api/v1/getassetpairs
RESPONSE EXAMPLE (200 OK):
{
"Success": true,
"Message": "",
"Result": [
{
"AssetPairId": 2,
"BaseAssetId": 1,
"QuoteAssetId": 7,
"Name": "LTC/BTC",
"FeePercentage": 0.00250000,
"PricePrecision": 6,
"AmountPrecision": 3,
"TotalPrecision": 8
}
]
}
GET /GetAssetPairSummary
No Authorization Required
Read Permission
DESCRIPTION
Returns the last 24 hour information of the specified asset pair.
REQUEST PARAMETERS
(required)AssetPair:string
Example ETH-BTC
EXAMPLE REQUEST URL:
https://www.oodlebit.com/api/v1/getassetpairsummary?assetpair=ETH-BTC
RESPONSE EXAMPLE (200 OK):
{
"Success": true,
"Message": "",
"Result": [
{
"AssetPairId": 1,
"AssetPair": "ETH/BTC",
"High": 0.02677100,
"Low": 0.02110400,
"Volume": 0.0,
"LastPrice": 0.02084400,
"YesterdayPrice": 0.02052100,
"BID": 0.02084300,
"ASK": 0.02084900,
"BuyOrders": 10,
"SellOrders": 22,
"PricePrecision": 6,
"AmountPrecision": 3,
"TotalPrecision": 8
}
]
}
GET /GetAssetPairSummaries
No Authorization Required
Read Permission
DESCRIPTION
Returns the last 24 information on all available asset pairs.
EXAMPLE REQUEST URL:
https://www.oodlebit.com/api/v1/getassetpairsummaries
RESPONSE EXAMPLE (200 OK):
{
"Success": true,
"Message": "",
"Result": [
{
"AssetPairId": 1,
"AssetPair": "ETH/BTC",
"High": 0.02677100,
"Low": 0.02110400,
"Volume": 0.0,
"LastPrice": 0.02084400,
"YesterdayPrice": 0.02052100,
"BID": 0.02084300,
"ASK": 0.02084900,
"BuyOrders": 10,
"SellOrders": 22,
"PricePrecision": 6,
"AmountPrecision": 3,
"TotalPrecision": 8
}
]
}
GET /GetTicker
No Authorization Required
Read Permission
DESCRIPTION
Returns the latest ticker information for the specified asset pair.
REQUEST PARAMETERS
(required)AssetPair:string
Example ETH-BTC
EXAMPLE REQUEST URL:
https://www.oodlebit.com/api/v1/getticker?assetpair=ETH-BTC
RESPONSE EXAMPLE (200 OK):
{
"Success": true,
"Message": "",
"Result": [
{
"AssetPair": "ETH/BTC",
"LastPrice": 0.02084400,
"BID": 0.02084300,
"ASK": 0.02084900
}
]
}
GET /GetAssetPairHistory
No Authorization Required
Read Permission
DESCRIPTION
Returns the latest trades for the specified asset pair.
REQUEST PARAMETERS
(required)AssetPair:string
Example ETH-BTC
EXAMPLE REQUEST URL:
https://www.oodlebit.com/api/v1/getassetpairhistory?assetpair=ETH-BTC
RESPONSE EXAMPLE (200 OK):
{
"Success": true,
"Message": "",
"Result": [
{
"ID": 1,
"TransactionTime": "2019-07-15T11:08:06",
"Amount": 25.00000000,
"Price": 0.00867500,
"Total": 0.21687500,
"OrderType": "SELL"
}
]
}
GET /GetOrderBook
No Authorization Required
Read Permission
DESCRIPTION
Returns all open orders in the orderbooks.
REQUEST PARAMETERS
(required)AssetPair:string
Example ETH-BTC
(required)OrderType:string
Buy, sell or both
EXAMPLE REQUEST URL:
https://www.oodlebit.com/api/v1/getorderbook?assetpair=ETH-BTC&ordertype=both
RESPONSE EXAMPLE (200 OK):
{
"Success": true,
"Message": "",
"Result": [
{
"AssetPairId": 1,
"OrderBookId": 1,
"Price": 0.02084900,
"Amount": 0.04040000,
"IsBuyOrder": "SELL"
}
]
}
GET /CreateOrder
Authorization Required
Trade Permission
DESCRIPTION
Opens a new order in the specified asset pair. Returns UUID of the order when successful. Status: P = Open Order C = Cancelled Order F = Executed Order
You can choose to send either Amount or Total but you can not send both. Its highly recommended that you send
Total when placing a Buy order, and to send Amount when placing a Sell order.
By sending Amount for a Buy order you are not guaranteed the Amount as the order will be fullfilled using a calculated Total. The Total is calculated with the following equation (Amount * (ReceivedPrice or LastPrice)).
By specifying a Total in your request you are guaranteed to receive the Total minus any fees once your order fully executes.
By sending Total for a Sell order you are not guaranteed the Total as the order will be fullfilled using a calculated Amount. The Amount is calculated with the following equation (Total / (ReceivedPrice or LastPrice)).
By specifying a Amount in your request you are guaranteed to receive the Amount minus any fees once your order fully executes.
Make sure Price, Amount, and Total values do not exceed the allowed decimal precision. For example, If the max allowed precision for Price is 3, a Price of x.xxxx would fail, while x.xxx would be accepted. You can retrieve these values by calling any of the GetAssetPair APIs.
REQUEST PARAMETERS
(required)AssetPair:string
Example ETH-BTC
(required)OrderPosition:string
Buy or sell
(required)OrderType:string
L = Limit M = Market R = Stop Limit S = Stop Loss
(required)Price:decimal
The price of your order.
(optional)StopPrice:decimal
Order opens when StopPrice is met - only required when ordertype = R
(optional)Amount:decimal
Amount to order.
(optional)Total:decimal
Total to order.
EXAMPLE REQUEST URL:
https://www.oodlebit.com/api/v1/createorder?assetpair=ETH-BTC&orderposition=buy&ordertype=L&price=0.018&total=0.05
RESPONSE EXAMPLE (200 OK):
{
"Success": true,
"Message": "",
"Result": [
{
"UUID": "1c79c61f-8547-49d6-9450-1e27456119fa"
}
]
}
GET /CancelOrder
Authorization Required
Trade Permission
DESCRIPTION
Cancels the open order of the specified UUID.
REQUEST PARAMETERS
(required)UUID:string
The UUID of the open order.
EXAMPLE REQUEST URL:
https://www.oodlebit.com/api/v1/cancelorder?UUID=1c79c61f-8547-49d6-9450-1e27456119fa
RESPONSE EXAMPLE (200 OK):
{
"Success": true,
"Message": "",
"Result": [
{
"UUID": "f57a42e1-9862-467d-89fd-7c48dc2f7dba"
}
]
GET /GetOpenOrders
Authorization Required
Read Permission
DESCRIPTION
Returns all open orders and their information for the specified asset pair.
REQUEST PARAMETERS
(required)AssetPair:string
Example ETH-BTC
EXAMPLE REQUEST URL:
https://www.oodlebit.com/api/v1/getopenorders?assetpair=LTC-BTC
RESPONSE EXAMPLE (200 OK):
{
"Success": true,
"Message": "",
"Result": [
{
"UUID": "bfac5de1-2ec1-46df-95e3-fbccb3106fd9",
"Amount": 10.00000000,
"AssetPair": "LTC/BTC",
"Filled": 0.0,
"OrderDate": "2019-07-15T12:12:13",
"Price": 0.00865000,
"Side": "Sell",
"Total": 0.08650000,
"OrderRequestId": 5328,
"Status": "P",
"Stop": 0.00000000,
"OrderType": "L",
"BaseDecimals": 6
}
]
}
GET /GetOrder
Authorization Required
Read Permission
DESCRIPTION
Returns information on a specified open order based on its UUID.
REQUEST PARAMETERS
(required)UUID:string
The UUID of the open order.
EXAMPLE REQUEST URL:
https://www.oodlebit.com/api/v1/getorder?UUID=bfac5de1-2ec1-46df-95e3-fbccb3106fd9
RESPONSE EXAMPLE (200 OK):
{
"Success": true,
"Message": "",
"Result": [
{
"UUID": "bfac5de1-2ec1-46df-95e3-fbccb3106fd9",
"Amount": 10.00000000,
"AssetPair": "LTC/BTC",
"Filled": 0.0,
"OrderDate": "2019-07-15T12:12:13",
"Price": 0.00865000,
"Side": "Sell",
"Total": 0.08650000,
"OrderRequestId": 5328,
"Status": "P",
"Stop": 0.00000000,
"OrderType": "L",
"BaseDecimals": 6
}
]
}
GET /GetOrderHistory
Authorization Required
Read Permission
DESCRIPTION
Returns order history for the user on a specified asset pair.
REQUEST PARAMETERS
(required)AssetPair:string
Example ETH-BTC
EXAMPLE REQUEST URL:
https://www.oodlebit.com/api/v1/getorderhistory?assetpair=ETH-BTC
RESPONSE EXAMPLE (200 OK):
{
"Success": true,
"Message": "",
"Result": [
{
"UUID": "bfac5de1-2ec1-46df-95e3-fbccb3106fd9",
"Amount": 10.00000000,
"AssetPair": "LTC/BTC",
"Filled": 0.0,
"OrderDate": "2019-07-15T12:12:13",
"Price": 0.00865000,
"Side": "Sell",
"Total": 0.08650000,
"OrderRequestId": 5328,
"Status": "P",
"Stop": 0.00000000,
"OrderType": "L",
"BaseDecimals": 6
}
]
}
GET /GetBalances
Authorization Required
Read Permission
DESCRIPTION
Returns all wallet balances greater than zero for the user.
EXAMPLE REQUEST URL:
https://www.oodlebit.com/api/v1/getbalances
RESPONSE EXAMPLE (200 OK):
{
"Success": true,
"Message": "",
"Result": [
{
"AssetId": 1,
"AssetName": "BTC",
"Balance": 100000.54320621,
"AvailableBalance": 99999.02715421,
"PendingWithdrawal": 0.00000000
}
]
}
GET /GetBalance
Authorization Required
Read Permission
DESCRIPTION
Returns wallet balance information for the specified asset.
REQUEST PARAMETERS
(required)Asset:string
Example BTC
EXAMPLE REQUEST URL:
https://www.oodlebit.com/api/v1/getbalance?asset=BTC
RESPONSE EXAMPLE (200 OK):
{
"Success": true,
"Message": "",
"Result": [
{
"AssetId": 1,
"AssetName": "BTC",
"Balance": 100000.54320621,
"AvailableBalance": 99999.02715421,
"PendingWithdrawal": 0.00000000
}
]
}
GET /DepositAddress
Authorization Required
Read Permission
DESCRIPTION
Returns deposit wallet address for specified asset.
REQUEST PARAMETERS
(required)Asset:string
Example BTC
EXAMPLE REQUEST URL:
https://www.oodlebit.com/api/v1/depositaddress?asset=BTC
RESPONSE EXAMPLE (200 OK):
{
"Success": true,
"Message": "",
"Result": [
{
"DepositAddress": 1F1tAaz5x1HUXrCNLbtMDqcw6o5GNn4xqX
}
]
}
GET /Withdraw
Authorization Required
Withdraw Permission
DESCRIPTION
User can withdraw assets from their specified asset wallet.
RISK WARNING
By enabling the Withdraw permissions for your API key you are putting your assets at risk. If your secret API key is compromised, your assets could be stolen. Oodlebit Inc. will not be liable for any financial loss. Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
REQUEST PARAMETERS
(required)Asset:string
The asset wallet to withdraw from. Example BTC
(required)Address:string
The address that will receive the withdrawn amount.
(required)Amount:decimal
The amount to withdraw from the asset wallet.
(required)TakeFeeAmount:bool
Take the withdrawal fee from the amount True or False.
EXAMPLE REQUEST URL:
https://www.oodlebit.com/api/v1/withdraw?asset=BTC&address=1Bpvb85nX4wGXiRDiKAHXENtNtzDE9WWyP&amount=0.037&takefeeamount=true
RESPONSE EXAMPLE (200 OK):
WithdrawAsset = asset.Name,
WithdrawAmount = WithdrawalAmount,
TakeFeeFromAmount = TakeFeeAmount,
WithdrawToAddress = WithdrawalAddress
{
"Success": true,
"Message": "",
"Result": [
{
"WithdrawAsset": BTC,
"WithdrawAmount": 0.037,
"TakeFeeFromAmount": true,
"WithdrawToAddress": 1F1tAaz5x1HUXrCNLbtMDqcw6o5GNn4xqX
}
]
}