Intoduction
Unnamed provides a simple and powerful API consisting of REST endpoints for transactional operations and a complementary Websocket service providing streaming market, order, and balance updates.
Access to and use of the API is governed by our Terms of Service. If you are a user of Unnamed, the applicable Terms of Service are available here.
Getting Started
Create an API Key You can create and manage your API Keys in you Settings section The API Key permission is granular so only enable the sections of the API you wish to use. Using the IP address whitelist restrictions for API keys is strongly recommended. Withdrawals are resticted to AddressBook entries only unless disabled explicitly. Rate Limiting The Unnamed API employs rate limiting on all endpoints to ensure the efficiency and availability of the platform for all customers. In general, API users are permitted to make a maximum of 100 API calls per minute. Calls after the limit will fail(HttpCode: 429), with the limit resetting at the start of the next minute. If you are a corporate customer and need higher rate limits please contact customer Support for additional information.
Public HTTP API Methods
The public HTTP API allows read access to public market data.There are nine public methods, all of which take HTTP GET requests and return output in JSON format. No authentication is necessary but you must not excessively use any API endpoint.
Ping
Simple ping method to test connection to the ApiTime
Returns the current server time in unix formatMarket Info
Returns all market informationAsset Info
Returns all currency informationWallet Info
Returns all wallet informationVolume
Returns market volumes for the past 24 hoursTicker
Returns market ticker informationcurl -X GET https://api.unnamed.exchange/v1/Public/Ticker
curl -X GET https://api.unnamed.exchange/v1/Public/Ticker?market=BTC
curl -X GET https://api.unnamed.exchange/v1/Public/Ticker?market=LTC_BTC
curl -X GET https://api.unnamed.exchange/v1/Public/Ticker?market=LTC_BTC-XMR_BTC-DOGE_BTC
TODO
TODO
OrderBook
Returns market orderbook informationcurl -X GET https://api.unnamed.exchange/v1/Public/OrderBook
curl -X GET https://api.unnamed.exchange/v1/Public/OrderBook?market=BTC
curl -X GET https://api.unnamed.exchange/v1/Public/OrderBook?market=LTC_BTC
curl -X GET https://api.unnamed.exchange/v1/Public/OrderBook?market=LTC_BTC-XMR_BTC-DOGE_BTC
curl -X GET https://api.unnamed.exchange/v1/Public/OrderBook?market=LTC_BTC&depth=10
TODO
TODO
Trade History
Returns market trading historycurl -X GET https://api.unnamed.exchange/v1/Public/TradeHistory
curl -X GET https://api.unnamed.exchange/v1/Public/TradeHistory?market=BTC
curl -X GET https://api.unnamed.exchange/v1/Public/TradeHistory?market=LTC_BTC
curl -X GET https://api.unnamed.exchange/v1/Public/TradeHistory?market=LTC_BTC-XMR_BTC-DOGE_BTC
curl -X GET https://api.unnamed.exchange/v1/Public/TradeHistory?market=LTC_BTC&depth=10
curl -X GET https://api.unnamed.exchange/v1/Public/TradeHistory?market=LTC_BTC&beginTime=1458158527&endTime=1558158527
TODO
TODO
Chart Points
Returns chart points for the selected marketcurl -X GET https://api.unnamed.exchange/v1/Public/Chart?market=LTC_BTC
curl -X GET https://api.unnamed.exchange/v1/Public/Chart?market=LTC_BTC&minutes=30
curl -X GET https://api.unnamed.exchange/v1/Public/Chart?market=LTC_BTC&beginTime=1458158527&endTime=1558158527
TODO
TODO
Private HTTP API Methods
The private HTTP API allows read / write access to your private account.All calls to the trading API are sent via HTTPS using POST parameters. All responses from the trading API are in JSON format. Required Headers: ApiKey: Your "API key" Signature: The POST data signed by your "API Secret" Additionally, all queries must include a "nonce" POST parameter. The nonce parameter is an integer which must always be greater than the previous nonce used and does not need to increase by one. Using the epoch in milliseconds is an easy choice here.
In the event of an error, the response will always be of the following format:
date +%s00000
echo -n "value1=123&value2=abc&nonce=154264078495400" | \
openssl sha512 -hmac "YOUR_API_SECRET"
curl -X POST \
-d "value1=123&value2=abc&nonce=154264078495400" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5....signature from above..cf44b290ce" \
https://api.unnamed.exchange/v1/Endpoint
TODO
TODO
Balance
Returns balanceName | Type | Required | Description |
---|---|---|---|
Symbol | Text | No | The coin symbol for single balance |
curl -X POST \
-d "nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/Balance
curl -X POST \
-d "symbol=BTC&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/Balance
TODO
TODO
Balance Full
Returns balanceName | Type | Required | Description |
---|---|---|---|
Symbol | string | No | The coin symbol for single balance |
curl -X POST \
-d "nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/BalanceFull
curl -X POST \
-d "symbol=BTC&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/BalanceFull
TODO
TODO
Order Submit
Submit a trade/orderName | Type | Required | Description |
---|---|---|---|
Market | string | Yes | Market identifier |
OrderType | enum | Yes | The type of order, Limit, StopLimit or Market |
Type | enum | Yes | The trade type, Buy or Sell |
Amount | decimal | Yes | The amount of coins to trade |
Price | decimal | Yes* | The price of the coins to trade *required for OrderType: Limit, StopLimit |
Stop | decimal | Yes* | The stop limit price if order type is StopLimit *required for OrderType: StopLimit |
curl -X POST \
-d "market=LTC_BTC&orderType=Limit&type=Buy&amount=100.00000000&price=0.00230000&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/OrderSubmit
curl -X POST \
-d "market=LTC_BTC&orderType=StopLimit&type=Buy&amount=100.00000000&price=0.00230000&stop=0.00240000&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/OrderSubmit
curl -X POST \
-d "market=LTC_BTC&orderType=Market&type=Sell&amount=100.00000000&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/OrderSubmit
TODO
TODO
Order Cancel
Cancel an open Limit/StopLimit orderName | Type | Required | Description |
---|---|---|---|
CancelType | enum | Yes | The type of cancel operation, Trade, TradePair and All |
OrderType | enum | Yes | The type of order, Limit or StopLimit |
OrderId | long | Yes* | The order identifier *required for CancelType: Trade |
Market | string | Yes* | Market identifier *required for CancelType: Market |
curl -X POST \
-d "cancelType=Trade&orderType=Limit&orderId=123456&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/OrderCancel
curl -X POST \
-d "market=LTC_BTC&cancelType=TradePair&orderType=Limit&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/OrderCancel
curl -X POST \
-d "cancelType=All&orderType=Limit&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/OrderCancel
TODO
TODO
Orders
Get a list of open ordersName | Type | Required | Description |
---|---|---|---|
Market | string | No | Market identifier |
curl -X POST \
-d "nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/Orders
curl -X POST \
-d "market=LTC_BTC&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/Orders
TODO
TODO
Order History
Get a list of historic ordersName | Type | Required | Description |
---|---|---|---|
Market | string | No | Market identifier |
Count | int | No | The amount of recordes to return (default: 50) |
curl -X POST \
-d "nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/OrderHistory
curl -X POST \
-d "market=LTC_BTC&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/OrderHistory
curl -X POST \
-d "count=1000&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/OrderHistory
TODO
TODO
Trade History
Get a list of completed tradesName | Type | Required | Description |
---|---|---|---|
Market | string | No | Market identifier |
Count | int | No | The amount of recordes to return (default: 50) |
curl -X POST \
-d "nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/TradeHistory
curl -X POST \
-d "market=LTC_BTC&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/TradeHistory
curl -X POST \
-d "count=1000&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/TradeHistory
TODO
TODO
Deposits
Get a list of deposits to your site addressesName | Type | Required | Description |
---|---|---|---|
Symbol | string | No | Asset identifier |
Count | int | No | The amount of recordes to return (default: 50) |
curl -X POST \
-d "nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/Deposits
curl -X POST \
-d "symbol=BTC&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/Deposits
curl -X POST \
-d "count=1000&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/Deposits
TODO
TODO
Generate Address
Generate an new deposit address for a specific assetName | Type | Required | Description |
---|---|---|---|
Symbol | string | Yes | Asset identifier |
Addresses
Return one or all deposit addressesName | Type | Required | Description |
---|---|---|---|
Symbol | string | No | Asset identifier |
curl -X POST \
-d "nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/Addresses
curl -X POST \
-d "symbol=BTC&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/Addresses
TODO
TODO
AddressBook
Return one or all addressbook entiresName | Type | Required | Description |
---|---|---|---|
Symbol | string | No | Asset identifier |
curl -X POST \
-d "nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/AddressBook
curl -X POST \
-d "symbol=BTC&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/AddressBook
TODO
TODO
Withdraw Submit
Submit a new withdrawal requestName | Type | Required | Description |
---|---|---|---|
Symbol | string | Yes | Asset identifier |
Amount | decimal | Yes | Asset identifier |
Address | string | Yes | Withdrawal address |
Base Address | string | No | Withdrawal base address (if required) |
AddressBookId | int | No | AddressBook identifier if withdrawing to an AddressBook entry |
curl -X POST \
-d "symbol=LTC&amount=1&address=ltc1qqpze6ywq5dk7qjgqynvmnj6ty72frka7d23wdc&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/WithdrawSubmit
curl -X POST \
-d "symbol=LTC&amount=1&addressBookId=8&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/WithdrawSubmit
TODO
TODO
Withdrawals
Return pending and historc withdrawalsName | Type | Required | Description |
---|---|---|---|
Symbol | string | No | Asset identifier |
Count | int | No | The amount of recordes to return (default: 50) |
curl -X POST \
-d "nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/Withdrawals
curl -X POST \
-d "symbol=BTC&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/Withdrawals
curl -X POST \
-d "count=1000&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/Withdrawals
TODO
TODO
Transfer Submit
Submit a new user-to-user transfer requestName | Type | Required | Description |
---|---|---|---|
Symbol | string | Yes | Asset identifier |
Amount | decimal | Yes | Asset identifier |
UserName | string | Yes | The username of the person to transfer to |
Memo | string | No | A message to attach to this transfer |
Transfers
Return a list of historic transfersName | Type | Required | Description |
---|---|---|---|
Symbol | string | No | Asset identifier |
Count | int | No | The amount of recordes to return (default: 50) |
curl -X POST \
-d "nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/Transfers
curl -X POST \
-d "symbol=BTC&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/Transfers
curl -X POST \
-d "count=1000&nonce=154264078495300" \
-H "ApiKey: $YOUR_API_KEY" \
-H "Signature: 0b2e84e5.....cf44b290ce" \
https://api.unnamed.exchange/v1/Trade/Transfers
TODO
TODO
Websocket
Websocket API to provide real-time updates and streaming data sets
Introduction
Microsoft Signalr is used for the websocket communtication, Microsoft provides libraries for most common runtime languages
The examples provided below are all in C# targeting the .NET Framework 4.7.X
Authentication
Connecting to the websocket API rerquires an authentication bearer token to be included in the header when connecting
To genereate this authentication token you must make a signend call to the GetAuthToken http endpoint
Connection
Connecting to the websocket API requires an authenticated bearer token to be included in the header when connecting
To genereate this access token you must make a signend call to the GetAuthToken http endpoint
using Microsoft.AspNet.SignalR.Client.Transports;
// Add your bearer authentcation token to the HubConnection headers
// Create a proxy to the ApiHub
// Start the HubConnection using WebSocketTransport
using System.Threading.Tasks;
using Microsoft.AspNet.SignalR.Client;
using Microsoft.AspNet.SignalR.Client.Transports;
using Newtonsoft.Json;
Subscribe
Methods to subscribe to market data streamsName | Type | Required | Description |
---|---|---|---|
Markets | string | Yes | Market(s) to subscribe too, 'allmarkets' will subscribe to everything |
Replace | bool | Yes | If this subscription should add to or replace existing markets |
// Subscribe to a single market
// Subscribe to multiple markets (comma seperated list)
Unsubscribe
Methods to unsubscribe from market data streams// Unsubscribe from all tickers
// Unsubscribe from everything
Tickers
Real-time updates on market ticker price changesOrderBook
Real-time updates on market orderbook changesName | Value |
---|---|
0 | Buy |
1 | Sell |
Name | Value |
---|---|
0 | Add |
1 | Remove |
2 | Update |
3 | Cancel |
MarketHistory
Real-time updates on market history changesName | Value |
---|---|
0 | Buy |
1 | Sell |
Balance
Real-time updates on personal balance changesOrders
Real-time updates on personal order changesName | Value |
---|---|
0 | Buy |
1 | Sell |
Name | Value |
---|---|
0 | Add |
1 | Remove |
2 | Update |
3 | Cancel |
StopLimit
Real-time updates on personal stop-limit order changesName | Value |
---|---|
0 | Buy |
1 | Sell |
Name | Value |
---|---|
0 | Add |
1 | Remove |
2 | Update |
3 | Cancel |
TradeHistory
Real-time updates on personal trade history changesName | Value |
---|---|
0 | Buy |
1 | Sell |