GetBTC REST API Документация
Для удобства пользования нашим сервисом, команда GetBTC предлагает современный интерфейс API для автоматизации доступа к бирже. На этой странице собраны все необходимые сведения для использования API, а также интеграции с приложениями за счёт использования HTTP-запросов.
Соединение с API
Получить доступ к API вы можете по следующей ссылке:
Допустимое количество запросов – до 60 в минуту.
Использование Public API
Для того, чтобы использовать общедоступный API, необходимо выполнить HTTP-запрос к конечной точке, отправляя запросы GET и POST для этого метода. Кроме того, вы можете отправить их в формате JSON, используя PAYLOAD-запрос.
Для получения доступа к использованию защищенных методов API необходимо получить специальный ключ API/секретную пару, особенности применения которых детально объяснены в этом документе.
Здесь приведены несколько примеров использования:
# Example request using CURL on the command line
curl "https://getbtc.org/api/transactions" \
-d currency="EUR" \
-d limit=5
// Example valid response
{"transactions": {
"0":{"id":"131","date":"2014-11-13 10:42:46","btc":"1.00000000","maker_type":"buy","price":"10.00","amount":"10.00","currency":"USD"},
"1":{"id":"129","date":"2014-11-11 11:14:12","btc":"0.50000000","maker_type":"buy","price":"11.27","amount":"5.63","currency":"EUR"},
"2":{"id":"128","date":"2014-11-11 11:13:49","btc":"0.50000000","maker_type":"buy","price":"10.91","amount":"5.46","currency":"USD"},
"3":{"id":"127","date":"2014-11-10 18:29:15","btc":"0.50000000","maker_type":"buy","price":"11.20","amount":"5.60","currency":"USD"},
"4":{"id":"126","date":"2014-11-10 18:25:21","btc":"0.50000000","maker_type":"buy","price":"11.20","amount":"5.60","currency":"USD"},
"request_currency":"USD"
}
}
// Example error response
{"errors":[{"message":"Invalid currency.","code":"INVALID_CURRENCY"}]}Общедоступные методы API
К таким методам доступ осуществляется без ключа API/учетной записи.
Статистика
По запросу GET можно получить статистику о текущем состоянии обмена:
GET https://getbtc.org/api/stats
Параметры:
currency (string) - Код валюты в трехбуквенном формате (USD/EUR/RUB). Значение по умолчанию - "USD". Здесь должна быть указана валюта, доступная для обмена.
Ответ:
bid (float) - Текущая цена bid.
ask (float) - Текущая цена ask.
last_price (float) - Цена последней проведенной транзакции.
last_transaction_type (string) - Действие, выполненное инициатором последней транзакции. Допустимые значения: "BUY" или "SELL".
last_transaction_currency (string) - Код валюты в формате EUR/RUB/USD, в которой была проведена последняя транзакция.
daily_change (float) - Сумма, на которую изменилась текущая цена (вверх или вниз) с момента последнего закрытия.
daily_change_percent (float) - Процент текущей цены в сравнением с последним закрытием.
max (float) - Сегодняшняя наибольшая цена транзакции.
min (float) - Сегодняшняя наименьшая цена транзакции.
open (float) - Сегодняшняя цена открытия (примечание: поскольку рынок всегда открыт, это значение является также вчерашней окончательной ценой).
total_btc_traded (int) – Общая сумма сделок BTC за последние 24 часа.
total_btc (int) – Количество всех BTC, существующих в мире.
market_cap (int) - Глобальная рыночная капитализация Bitcoin.
trade_volume (int) - Объем мировой торговли Bitcoin.
request_currency (string) - Валюта, в которой представлена эта информация.
Исторические Цены
Дает ежедневные цены закрытия рынка для выбранного периода.
GET https://getbtc.org/api/historical-prices
Параметры:
currency (string)- Код валюты в формате (USD/EUR/RUB). Значение по умолчанию - "USD". Здесь должна быть указана валюта, поддерживаемая обменом.
timeframe (string) - Сроки для вашего запроса. Допустимые значения: "1mon", "3mon", "6mon", "1year" и " ytd". По умолчанию установлено значение "1mon".
Ответ:
date (string) - Дата в формате YYYY-MM-DD.
price (float) - Цена закрытия для заданной даты.
request_currency (string) - Валюта, в которой предоставлена информация.
Книга Заявок
Возвращает информацию со всех заявок, открытых в настоящее время, в книгу заявок. Возвраты группируются следующим образом: для покупки и для продажи.
GET https://getbtc.org/api/order-book
Параметры:
currency (string) - Код валюты. Значение, установленное по умолчанию - "USD". Здесь необходимо указать валюту, поддерживаемую обменом.
Ответ:
price (float) – Предельная цена заявки.
order_amount (float) - Оставшаяся сумма в BTC.
order_value (float) - Остаточная стоимость заявки в вашей валюте.
converted_from (string) – Если заявка открыта не в запрашиваемой валюте, возвращает первоначальную валюту, в которой была сделана заявка.
request_currency (string) - Валюта, в которой представлена информация.
Транзакции
Можно получить список последних транзакций, которые произошли в обмене. Они упорядочены в порядке убывания по дате.
Параметры запроса:
currency (string) - Код валюты в формате (usd/eur/rub/btc). Обратите внимание: вы можете не использовать этот параметр. В таком случае, вы будете получать все цены в родной валюте.
limit (int) - Получить количество записей. По умолчанию задано значение 10.
Ответ:
id (int) - Уникальный идентификатор для проведения транзакции.
date (string) - Дата в формате YYYY-MM-DD.
btc (float) - Сумма транзакции в BTC.
price (float) - Цена, по которой произошла транзакция. Если никакой параметр валюты не был отправлен в запросе, то цена возвращается в оригинальной валюте.
price1 (float) – Возвращается, если никакой параметр валюты не был отправлен в запросе - Цена, по которой данная транзакция произошла для производителя. Значение указано в оригинальной валюте.
amount (float) - Сумма сделки в запрашиваемой валюте. Если ни один параметр валюты не был отправлен в запросе,то возвращается в оригинальной валюте.
amount1 (float) - Только в случаях, если параметр валюты не был отправлен в запросе -Сумма транзакции в оригинальной валюте второй стороны (производителя).
currency (string) - Валюта, в которой произошла транзакция. Если ни один параметр валюты не отправляется в запросе, возвращается в оригинальной.
currency1 (string) – Если параметр валюты не был отправлен в запросе - Оригинальная валюта второй стороны (производителя).
request_currency (string) - Валюта, в которой значения были представлены. Возвращает 'ORIGINAL', если сумма в оригинальной валюте.
Защищенные методы API
Чтобы использовать эти методы, необходимо получить пару ключ/секрет API для проверки подлинности вашего запроса.
Получение Ключа API
Для получения доступа к нашему API, нужно сгенерировать специальный ключ API на странице API доступа. Необходимо включить двухфакторную аутентификацию на вашем счете, чтобы иметь возможность просмотра этой страницы. При создании нового ключа API, система предоставит секретный код API. Это значение будет показано только один раз. Пожалуйста, храните его в безопасном месте, поскольку этот код необходим для использования вместе с вашим ключом API.
После создания ключа API, вы можете разрешить или ограничить доступ его владельцу к функциональности родительского счета, установив или сняв флажки в строке «разрешения» под ключом API.
Аутентификация Вашего Запроса
Чтобы проверить подлинность своего запроса с парой ключ/секрет API, вы должны включить следующие параметры в ваши параметры POST или JSON PAYLOAD вашего запроса:
api_key (string) - Ключ API, который вы сгенерировали.
nonce (int) - Случайное целое число. Каждый запрос должен иметь значение nonce выше, чем предыдущий. К примеру, вы можете использовать текущую метку времени UNIX.
signature (string) - Подпись HMAC-SHA256 закодированных в JSON параметров запроса, подписанного с использованием API secret, который был сгенерирован вместе с api_key. Эти параметры включают в себя api_key и nonce. Данная подпись должна быть добавлена к параметрам запроса.
Мы знаем, что создание подписи может быть немного сложным, если вы делаете это впервые. Рекомендуем ознакомиться со следующими примерами:
// Javascript Example
// Uses http://crypto-js.googlecode.com/svn/tags/3.0.2/build/rollups/hmac-sha256.js
// ...and http://crypto-js.googlecode.com/svn/tags/3.0.2/build/components/enc-base64-min.js
// we add our public key and nonce to whatever parameters we are sending
var params = {};
params.currency = "eur";
params.price = 200;
params.api_key = api_key;
params.nonce = Math.round(new Date().getTime() / 1000);
// create the signature
var hash = CryptoJS.HmacSHA256(JSON.stringify(data), api_secret);
var hashInBase64 = CryptoJS.enc.Hex.stringify(hash);
// add signature to request parameters
params.signature = hashInBase64;// PHP Example
// we add our public key and nonce to whatever parameters we are sending
$commands['side'] = 'sell';
$commands['type'] = 'stop';
$commands['api_key'] = $api_key;
$commands['nonce'] = time();
// create the signature
$signature = hash_hmac('sha256', json_encode($commands), $api_secret);
// add signature to request parameters
$commands['signature'] = $signature;
# Python Example
import hashlib
import hmac
// we add our public key and nonce to whatever parameters we are sending
params = {'currency': 'eur', 'price': 200, 'api_key': api_key, 'nonce': time.time()}
// create the signature
message = bytes(json.dumps(params)).encode('utf-8')
secret = bytes(api_secret).encode('utf-8')
signature = hmac.new(secret, message, digestmod=hashlib.sha256).hexdigest()
// add signature to request parameters
params['signature'] = signature // C# Example
using System.Security.Cryptography;
// we add our public key and nonce to whatever parameters we are sending
var params1 = new List>();
params1.Add(new KeyValuePair("api_key", api_key));
params1.Add(new KeyValuePair("nonce", (Int32)(DateTime.UtcNow.Subtract(new DateTime(1970, 1, 1))).TotalSeconds));
// create the signature
JavaScriptSerializer serializer = new JavaScriptSerializer();
var message = serializer.Serialize(params1);
secret = secret ?? "";
var encoding = new System.Text.ASCIIEncoding();
byte[] keyByte = encoding.GetBytes(secret);
byte[] messageBytes = encoding.GetBytes(message);
using (var hmacsha256 = new HMACSHA256(keyByte))
{
byte[] hashmessage = hmacsha256.ComputeHash(messageBytes);
var signature = BitConverter.ToString(hashmessage);
signature = signature.Replace("-", "");
// add signature to request parameters
params1.Add(new KeyValuePair("signature", signature));
}/* Java Example */
/* Dependent on Apache Commons Codec to encode in base64. */
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import org.apache.commons.codec.binary.Hex;
/* we add our public key and nonce to whatever parameters we are sending */
Map params = new HashMap();
params.put("api_key", "demo");
params.put("nonce", ((int) (System.currentTimeMillis() / 1000L)));
/* create the signature */
String secret = "secret";
String message = new JSONObject(params).toString();
Mac sha256_HMAC = Mac.getInstance("HmacSHA256");
SecretKeySpec secret_key = new SecretKeySpec(secret.getBytes(), "HmacSHA256");
sha256_HMAC.init(secret_key);
String hash = Hex.encodeHexString(sha256_HMAC.doFinal(message.getBytes()));
/* add signature to request parameters */
params.put("signature", hash);
Балансы и Информация
Получить балансы аккаунтов и уровни сборов:
POST https://getbtc.org/api/balances-and-info
Ответ:
on_hold[currency][withdrawal] (float) – Количество валюты для снятия по состоянию на текущий момент времени.
on_hold[currency][order] (float) - Количество валюты на ваших открытых заявках.
on_hold[currency][total] (float) - Общая сумма валюты, которая находится на удержании - сумма последних двух пунктов.
available[currency] (float) - Количество валюты, которая доступна в настоящее время.
usd_volume (float) - 30-дневный объем торговли вашей учетной записи, преобразованный в значение в долларах США.
fee_bracket[maker] (float) - Уровень платежа за транзакцию аккаунта (в процентах), если не инициирует транзакцию (т.е. выступает в качестве производителя).
fee_bracket[taker] (float) - Уровень платежа за транзакцию аккаунта (в процентах), если не инициирует транзакцию (т.е. выступает в качестве приобретателя).
global_btc_volume (float) –Обмен всего 24-часового объема транзакций в Биткоин.
Открытые Заявки
Для получения текущих открытых заявок аккаунта, которые сгруппированы по стороне заказа (bid или ask).
POST https://getbtc.org/api/open-orders
Параметры:
currency (string) - Код валюты в формате USD/EUR/RUB. Будет включен фильтр по заявкам именно этой валюты. Если этот параметр пропущен, на экран выведутся все открытые заявки.
Ответ:
id (int) - Уникальный идентификатор заявки.
side (string) - "buy" или "sell".
type (string) - "market", "limit" или "stop".
amount (float) - Сумма первоначальной заявки в BTC.
amount_remaining (float) - Сумма, которая еще не была заполнена в BTC.
price (float) - Текущая цена заявки в вашей национальной валюте.
avg_price_executed (float) - Средневзвешенная цена, по которой заявка была заполнена, в национальной валюте. Ответ 0 – сделки еще не сгенерированы.
stop_price (float) –Цена, при которой будет срабатывать стоп, если есть заявка стоп-ордер.
currency (string) - Национальная валюта заявки.
status (string) - Текущий статус заявки. Возможные значения 'ACTIVE','FILLED','CANCELLED_USER','OUT_OF_FUNDS','REPLACED'.
replaced (int) - Если заявка была отредактирована, она замещается.
replaced_by (int) - Если заявка была заменена, id заявки замещается.
Сделки Пользователей
Команда возвращает список транзакций учетной записи, которые упорядочены по дате. Вывод производится в порядке убывания.
POST https://getbtc.org/api/user-transactions
Параметры:
currency (string) - Код валюты в формате 3 - х букв. Происходит фильтр по транзакциям, включающим именно эту валюту. Если значение пропущено, то все транзакции будут выведены на экран.
limit (int) - Количество транзакций на возврат.
side (string) - Фильтры сделок по типу ("buy" или "sell").
Ответ:
id (int) - Уникальный идентификатор транзакции.
date (string) - Дата в формате YYYY-MM-DD.
btc (float) - Сумма транзакции в BTC.
side (string) – Может быть "buy" или "sell".
price (float) – Цена, по которой была произведена транзакция, в национальной валюте.
amount (float) – Сумма транзакции в национальной валюте.
fee (float) - Платеж за транзакцию в национальной валюте.
currency (string) - Валюта , в которой была произведена транзакция.
Существующие Биткойн Адреса Для Депозита
Получить список существующих адресов учетной записи для получения биткоинов.
POST https://getbtc.org/api/btc-deposit-address/get
Параметры:
limit (int) - Количество адресов для возврата.
Ответ:
address (string) - Адрес для ввода биткоинов.
date (string) - Строка даты в формате YYYY-MM-DD HH:MM:SS.
Получить Новые Биткойн Адреса Для Депозита
Для получения новых биткоин-адресов для вашего аккаунта:
POST https://getbtc.org/api/btc-deposit-address/new
Ответ:
address (string) – Новые адреса для внесения Bitcoin.
Получить Депозиты
С помощью этой команды вы можете получить список депозитов (BTC или fiat) внесенных на счет. Они упорядочены по дате в порядке убывания.
POST https://getbtc.org/api/deposits/get
Параметры:
currency (string) - Код валюты в трехбуквенном формате. Происходит фильтрация по депозитам, включающим эту валюту. Если значение пропущено – на экран выводятся все депозиты.
limit (int) - Количество депозитов к возврату.
status (string) – Фильтры депозитов со статусом ("pending", "completed" или "cancelled").
Ответ:
id (int) - Уникальный идентификатор для депозита.
date (string) - Дата YYYY-MM-DD HH:MM:SS.
currency (string) – Валюта депозита.
amount (float) – Сумма депозита, в валюте ввода.
status (string) – Текущий статус транзакции. Возможные значения: "PENDING", "COMPLETED" или "CANCELLED".
account_number (int) – Номер аккаунта, с которого был совершен депозит (активно только для фиатных депозитов).
address (string) - Bitcoin адрес, с которого был совершен депозит (активно только для BTC депозитов).
Получить Вывод
Вы можете получить список всех выводов (BTC или fiat) с вашего счета. Они упорядочены по дате, в порядке убывания.
POST https://getbtc.org/api/withdrawals/get
Параметры:
currency (string) - Код валюты в трехбуквенном формате. Фильтрует по выводам, включающим эту валюту. Если значение отсутствует, все выводы будут выведены на экран.
limit (int) – Сумма всех выводов к возврату.
status (string) – Фильтры вывода со статусом ("pending", "completed" или "cancelled").
Ответ:
id (int) - Уникальный идентификатор для вывода.
date (string) — Дата в формате YYYY-MM-DD HH:MM:SS.
currency (string) – Валюта вывода.
amount (float) – Сумма вывода, в валюте вывода.
status (string) - Текущий статус вашей транзакции. Значения: "PENDING", "COMPLETED" или "CANCELLED".
account_number (int) – Номер аккаунта на который был сделан вывод (только для fiat вывода).
address (string) – Bitcoin - адрес, на который был сделан вывод (актуально только для BTC выводов).
Разместить Одну (или Несколько) Новых Заявок
С помощью этой команды возможно поместить одну или несколько новых заявок с вашего счета. Чтобы разместить несколько заявок, вы можете отправить многомерный массив с именем заявки. Массив должен содержать все параметры в каждом из элементов массива, как указано ниже в примере.
POST https://getbtc.org/api/orders/new
Параметры:
side (string) – Может быть "buy" или "sell".
type (string) – Может быть "market", "limit" или "stop". "stop" заявки могут содержать как stop_price, так и limit_price - они будут обработаны в OCO виде (One Cancels the Other-исполнение одной заявки отменяет другую или взаимоотменяющие заявки).
currency (string) - Код валюты в трехбуквенном формате. Валюта, в которой будет сделана заявка.
limit_price (float) - Предельная цена для заявки, в валюте заявки.
stop_price (float) - Стоп-цена для заявки, в валюте заявки. "Stop" заявка может иметь и stop и limit цены, как описано в "type ".
amount (float) - Количество BTC для покупки или продажи.
orders (array) - Этот параметр используется, только если Вы намереваетесь разместить многократные заявки в одном запросе API. Это должен быть массив или JSON строка, содержащая все предыдущие параметры для каждого элемента, такие как заявки [n] = ['side'=>x,'type'=>y,...]. Это может быть как простой массив HTTP параметров, так и может быть отформатировано как JSON.
Ответ:
transactions (int) - Количество сделок которые произошли после размещения вашей заявки.
new_order (int) – Количество новых размещенных заказов (возвращает 2, если стоп-ордер имеет как limit_price, так и stop_price).
id (int) - Уникальный идентификатор вывода.
side (string) – Может быть "buy" или "sell".
type (string) – Может быть "market", "limit" или "stop".
amount (float) – Оригинальная сумма BTC для продажи или покупки.
amount_remaining (float) - Непогашенная сумма BTC (в процессе выполнения) по заявке.
price (float) - Текущая цена заявки в родной валюте.
avg_price_executed (float) - Средневзвешенная из цен, по которым заявка была заполнена, в ее валюте. Возврат ноля означает, что он еще не генерируется никаких сделок.
stop_price (float) - Если есть заявка стоп-ордер, цена, при которой будет срабатывать стоп.
currency (string) – Национальная валюта заявки.
status (string) - Текущий статус заявки. Диапазон возможных значений: 'ACTIVE','FILLED','CANCELLED_USER','OUT_OF_FUNDS','REPLACED'.
oco (boolean) - Если стоп-ордер имеет и стоп и лимит цены, значением будет true.
Редактировать Одну (или Несколько) Заявок
Можно изменить одну или несколько заявок, которые вы разместили. Чтобы изменить несколько заявок, вы можете отправить многомерный массив, называемый «заявки», который должен содержать все параметры в каждом элементе массива, как указано ниже в примере:
POST https://getbtc.org/api/orders/edit
Параметры:
id (int) - Уникальный идентификатор заявки, которую вы собираетесь редактировать.
type (string) - Может быть "market", "limit" или "stop". "stop" заявки могут содержать как stop_price, так и limit_price - они будут обработаны в OCO виде (One Cancels the Other-исполнение одной заявки отменяет другую или взаимоотменяющие заявки).
limit_price (float) - Предельная цена для заявки, в валюте заявки.
stop_price (float) - Стоп-цена для заявки, в валюте заявки. "Stop" заявка может иметь и stop и limit цены, как описано в " type ".
amount (float) - Сумма BTC для продажи или покупки.
orders (array) - Этот параметр используется в случаях, если Вы собираетесь разместить многократные заявки в одном запросе API. Это должен быть массив или JSON строка, содержащая все предыдущие параметры для каждого элемента, такие как заявки[n] = ['id'=>x,'type'=>y,...]. Это может быть простым массивом HTTP параметров или может быть отформатировано как JSON.
Ответ:
transactions (int) - Количество сделок, которые произошли после редактирования заявки.
edit_order (int) - Количество новых размещенных заявок (возвращает 2, если стоп-приказ содержит как limit_price так и stop_price).
id (int) - Новый id для заявки (в предыдущей заявке id будет отмечен "REPLACED"). Это позволяет отслеживать любые пользовательские изменения к заявке.
side (string) - Может быть "buy" или "sell".
type (string) -Может быть "market", "limit" или "stop".
amount (float) - Количество BTC, оставшееся в заявке во время редактирования.
amount_remaining (float) - Непогашенная сумма BTC (но должно быть выполнено) по заявке.
price (float) - Текущая цена заявки в своей родной валюте.
avg_price_executed (float) - Средневзвешенная из цен, по которым заявка была заполнена, в ее валюте. Ноль означает, что он еще не генерируется никаких сделок.
stop_price (float) - Если есть заявка стоп-ордер, цена, при которой будет срабатывать стоп.
currency (string) - Валюта заявки.
status (string) - Текущий статус заявки. Возможные значения 'ACTIVE','FILLED','CANCELLED_USER','OUT_OF_FUNDS','REPLACED'.
replaced (int) - Заявка заменит указанную.
oco (boolean) - Если стоп-ордер имеет стоп и лимит цены, возвращает true.
Отменить Одну, Многие или Все заявки
С помощью этой команды возможно отменить одну или несколько активных заявок. Чтобы отменить несколько заказов, вы можете отправить многомерный массив называемый orders, который должен содержать все параметры в каждом элементе массива, как указано ниже. Чтобы отменить ВСЕ заявки, просто отправьте параметр, называемый all.
POST https://getbtc.org/api/orders/cancel
Параметры:
id (int) - Уникальный идентификатор заявки, которую вы хотите редактировать.
orders (array) - Этот параметр используется, только если вы намерены получить статус нескольких заявок в одном вызове API. Он должен быть массивом или строкой JSON, содержащей параметр id для каждого элемента, например, как такие заявки [n] = ['id' => x]. Это может быть простой массив параметров HTTP, или может быть отформатирован как JSON.
all (bool)- Отправка этого параметра отменит ВСЕ заявки. Будьте осторожны!
Ответ:
id (int) – Уникальный идентификатор заявки.
side (string) – Может быть "buy" или "sell".
type (string) – Может быть"market", "limit" или "stop".
amount (float) - Первоначальная сумма BTC, когда заявка была размещена или отредактирована.
amount_remaining (float) – Непогашенная сумма BTC (но должно быть выполнено) по заявке.
price (float) - Текущая цена заявки в национальной валюте.
avg_price_executed (float) - Средневзвешенная из цен, по которой заявка была заполнена, в ее валюте. Если возвращен ноль – это значит, что в данный момент не генерируется никаких операций.
stop_price (float) - Если есть заявка стоп-ордер, возвращает цену, при которой будет срабатывать стоп.
currency (string) – Валюта заявки.
status (string) - Текущий статус заявки. Возможные значения 'ACTIVE','FILLED','CANCELLED_USER','OUT_OF_FUNDS','REPLACED'.
replaced (int) - Заявка заменит эту, если была отредактирована.
replaced_by (int) – Заявка, которая заменит эту, если "REPLACED".
Статус Одной (или Нескольких) Заявок
Эта команда поможет вам получить текущее состояние одной или нескольких заявок, которые были размещены на счету. Для получения нескольких заявок, необходимо отправить многомерный массив, именуемый заявки, который должен содержать все параметры в каждом элементе массива, как указано ниже в примере.
POST https://getbtc.org/api/orders/status
Параметры:
id (int) - Уникальный идентификатор заявки, которую вы собираетесь редактировать.
orders (array) - Этот параметр используется, только если вы намерены получить статус нескольких заявок в одном вызове API. Он должен быть массивом или строкой JSON, содержащей параметр id для каждого элемента, например, как такие заявки [n] = ['id' => x]. Это может быть простой массив параметров HTTP, или он может быть отформатирован как JSON.
Ответ:
id (int) – Уникальный идентификатор заявки.
side (string) – Может быть "buy" или "sell".
type (string) – Может быть"market", "limit" или "stop".
amount (float) - Первоначальная сумма BTC, в момент, когда заявка была размещена или отредактирована.
amount_remaining (float) – Непогашенная сумма BTC (в процессе выполнения) по заявке.
price (float) - Текущая цена заявки в национальной валюте.
avg_price_executed (float) - Средневзвешенная из цен, по которой заявка была заполнена, в ее валюте. Ноль означает, что еще не генерируется никаких операций.
stop_price (float) - Если есть заявка стоп-ордер, возвращает цену, при которой будет срабатывать стоп.
currency (string) – Валюта заявки.
status (string) - Текущий статус заявки. Возможные значения 'ACTIVE','FILLED','CANCELLED_USER','OUT_OF_FUNDS','REPLACED'.
replaced (int) - Заявка заменит эту, если была отредактирована.
replaced_by (int) – Заявка, которая заменит эту, если "REPLACED".
Сделать Вывод Средств
Команда используется для выведения средств из аккаунта на существующий Bitcoin - адрес или банковский fiat счет. Обращаем внимание: Вы должны привязать желаемый номер банковского счета к своей учетной записи на странице банковских счетов для того, чтобы эта функция работала. В противном случае, операция снятия не будет успешной.
POST https://getbtc.org/api/withdrawals/new
Параметры:
currency (string) - Код валюты в формате USD/EUR/RUB/BTC, которую вы намерены снять. Значение должно совпадать с валютой на счете, если вы снимаете fiat-валюту.
amount (float) - Сумма, которую необходимо снять (в приведенной выше валюте).
address (string) – Для вывода BTС. Bitcoin адрес, по которому вы хотите вывести.
account_number (int) – Для вывода фиатных денег. Номер банковского счета, на который Вы планируете вывести валюту.
Ответ:
id (int) – Уникальный идентификатор для вывода.
date (string) - Дата в формате YYYY-MM-DD HH:MM:SS.
currency (string) – Валюта вывода.
amount (float) – Сумма вывода, в валюте вывода.
status (string) - Текущий статус сделки. Может быть"PENDING", "COMPLETED" или "CANCELLED".
account_number (int) - Номер счета, на который был сделан вывод (только для вывода fiat).
address (string) - Адрес Bitcoin, на который был сделан вывод (только для вывода BTC).
GetBTC REST API Документация
Для удобства пользования нашим сервисом, команда GetBTC предлагает современный интерфейс API для автоматизации доступа к бирже. На этой странице собраны все необходимые сведения для использования API, а также интеграции с приложениями за счёт использования HTTP-запросов.
Соединение с API
Получить доступ к API вы можете по следующей ссылке:
Допустимое количество запросов – до 60 в минуту.
Использование Public API
Для того, чтобы использовать общедоступный API, необходимо выполнить HTTP-запрос к конечной точке, отправляя запросы GET и POST для этого метода. Кроме того, вы можете отправить их в формате JSON, используя PAYLOAD-запрос.
Для получения доступа к использованию защищенных методов API необходимо получить специальный ключ API/секретную пару, особенности применения которых детально объяснены в этом документе.
Здесь приведены несколько примеров использования:
# Example request using CURL on the command line
curl "https://getbtc.org/api/transactions" \
-d currency="EUR" \
-d limit=5
// Example valid response
{"transactions": {
"0":{"id":"131","date":"2014-11-13 10:42:46","btc":"1.00000000","maker_type":"buy","price":"10.00","amount":"10.00","currency":"USD"},
"1":{"id":"129","date":"2014-11-11 11:14:12","btc":"0.50000000","maker_type":"buy","price":"11.27","amount":"5.63","currency":"EUR"},
"2":{"id":"128","date":"2014-11-11 11:13:49","btc":"0.50000000","maker_type":"buy","price":"10.91","amount":"5.46","currency":"USD"},
"3":{"id":"127","date":"2014-11-10 18:29:15","btc":"0.50000000","maker_type":"buy","price":"11.20","amount":"5.60","currency":"USD"},
"4":{"id":"126","date":"2014-11-10 18:25:21","btc":"0.50000000","maker_type":"buy","price":"11.20","amount":"5.60","currency":"USD"},
"request_currency":"USD"
}
}
// Example error response
{"errors":[{"message":"Invalid currency.","code":"INVALID_CURRENCY"}]}Общедоступные методы API
К таким методам доступ осуществляется без ключа API/учетной записи.
Статистика
По запросу GET можно получить статистику о текущем состоянии обмена:
GET https://getbtc.org/api/stats
Параметры:
currency (string) - Код валюты в трехбуквенном формате (USD/EUR/RUB). Значение по умолчанию - "USD". Здесь должна быть указана валюта, доступная для обмена.
Ответ:
bid (float) - Текущая цена bid.
ask (float) - Текущая цена ask.
last_price (float) - Цена последней проведенной транзакции.
last_transaction_type (string) - Действие, выполненное инициатором последней транзакции. Допустимые значения: "BUY" или "SELL".
last_transaction_currency (string) - Код валюты в формате EUR/RUB/USD, в которой была проведена последняя транзакция.
daily_change (float) - Сумма, на которую изменилась текущая цена (вверх или вниз) с момента последнего закрытия.
daily_change_percent (float) - Процент текущей цены в сравнением с последним закрытием.
max (float) - Сегодняшняя наибольшая цена транзакции.
min (float) - Сегодняшняя наименьшая цена транзакции.
open (float) - Сегодняшняя цена открытия (примечание: поскольку рынок всегда открыт, это значение является также вчерашней окончательной ценой).
total_btc_traded (int) – Общая сумма сделок BTC за последние 24 часа.
total_btc (int) – Количество всех BTC, существующих в мире.
market_cap (int) - Глобальная рыночная капитализация Bitcoin.
trade_volume (int) - Объем мировой торговли Bitcoin.
request_currency (string) - Валюта, в которой представлена эта информация.
Исторические Цены
Дает ежедневные цены закрытия рынка для выбранного периода.
GET https://getbtc.org/api/historical-prices
Параметры:
currency (string)- Код валюты в формате (USD/EUR/RUB). Значение по умолчанию - "USD". Здесь должна быть указана валюта, поддерживаемая обменом.
timeframe (string) - Сроки для вашего запроса. Допустимые значения: "1mon", "3mon", "6mon", "1year" и " ytd". По умолчанию установлено значение "1mon".
Ответ:
date (string) - Дата в формате YYYY-MM-DD.
price (float) - Цена закрытия для заданной даты.
request_currency (string) - Валюта, в которой предоставлена информация.
Книга Заявок
Возвращает информацию со всех заявок, открытых в настоящее время, в книгу заявок. Возвраты группируются следующим образом: для покупки и для продажи.
GET https://getbtc.org/api/order-book
Параметры:
currency (string) - Код валюты. Значение, установленное по умолчанию - "USD". Здесь необходимо указать валюту, поддерживаемую обменом.
Ответ:
price (float) – Предельная цена заявки.
order_amount (float) - Оставшаяся сумма в BTC.
order_value (float) - Остаточная стоимость заявки в вашей валюте.
converted_from (string) – Если заявка открыта не в запрашиваемой валюте, возвращает первоначальную валюту, в которой была сделана заявка.
request_currency (string) - Валюта, в которой представлена информация.
Транзакции
Можно получить список последних транзакций, которые произошли в обмене. Они упорядочены в порядке убывания по дате.
Параметры запроса:
currency (string) - Код валюты в формате (usd/eur/rub/btc). Обратите внимание: вы можете не использовать этот параметр. В таком случае, вы будете получать все цены в родной валюте.
limit (int) - Получить количество записей. По умолчанию задано значение 10.
Ответ:
id (int) - Уникальный идентификатор для проведения транзакции.
date (string) - Дата в формате YYYY-MM-DD.
btc (float) - Сумма транзакции в BTC.
price (float) - Цена, по которой произошла транзакция. Если никакой параметр валюты не был отправлен в запросе, то цена возвращается в оригинальной валюте.
price1 (float) – Возвращается, если никакой параметр валюты не был отправлен в запросе - Цена, по которой данная транзакция произошла для производителя. Значение указано в оригинальной валюте.
amount (float) - Сумма сделки в запрашиваемой валюте. Если ни один параметр валюты не был отправлен в запросе,то возвращается в оригинальной валюте.
amount1 (float) - Только в случаях, если параметр валюты не был отправлен в запросе -Сумма транзакции в оригинальной валюте второй стороны (производителя).
currency (string) - Валюта, в которой произошла транзакция. Если ни один параметр валюты не отправляется в запросе, возвращается в оригинальной.
currency1 (string) – Если параметр валюты не был отправлен в запросе - Оригинальная валюта второй стороны (производителя).
request_currency (string) - Валюта, в которой значения были представлены. Возвращает 'ORIGINAL', если сумма в оригинальной валюте.
Защищенные методы API
Чтобы использовать эти методы, необходимо получить пару ключ/секрет API для проверки подлинности вашего запроса.
Получение Ключа API
Для получения доступа к нашему API, нужно сгенерировать специальный ключ API на странице API доступа. Необходимо включить двухфакторную аутентификацию на вашем счете, чтобы иметь возможность просмотра этой страницы. При создании нового ключа API, система предоставит секретный код API. Это значение будет показано только один раз. Пожалуйста, храните его в безопасном месте, поскольку этот код необходим для использования вместе с вашим ключом API.
После создания ключа API, вы можете разрешить или ограничить доступ его владельцу к функциональности родительского счета, установив или сняв флажки в строке «разрешения» под ключом API.
Аутентификация Вашего Запроса
Чтобы проверить подлинность своего запроса с парой ключ/секрет API, вы должны включить следующие параметры в ваши параметры POST или JSON PAYLOAD вашего запроса:
api_key (string) - Ключ API, который вы сгенерировали.
nonce (int) - Случайное целое число. Каждый запрос должен иметь значение nonce выше, чем предыдущий. К примеру, вы можете использовать текущую метку времени UNIX.
signature (string) - Подпись HMAC-SHA256 закодированных в JSON параметров запроса, подписанного с использованием API secret, который был сгенерирован вместе с api_key. Эти параметры включают в себя api_key и nonce. Данная подпись должна быть добавлена к параметрам запроса.
Мы знаем, что создание подписи может быть немного сложным, если вы делаете это впервые. Рекомендуем ознакомиться со следующими примерами:
// Javascript Example
// Uses http://crypto-js.googlecode.com/svn/tags/3.0.2/build/rollups/hmac-sha256.js
// ...and http://crypto-js.googlecode.com/svn/tags/3.0.2/build/components/enc-base64-min.js
// we add our public key and nonce to whatever parameters we are sending
var params = {};
params.currency = "eur";
params.price = 200;
params.api_key = api_key;
params.nonce = Math.round(new Date().getTime() / 1000);
// create the signature
var hash = CryptoJS.HmacSHA256(JSON.stringify(data), api_secret);
var hashInBase64 = CryptoJS.enc.Hex.stringify(hash);
// add signature to request parameters
params.signature = hashInBase64;// PHP Example
// we add our public key and nonce to whatever parameters we are sending
$commands['side'] = 'sell';
$commands['type'] = 'stop';
$commands['api_key'] = $api_key;
$commands['nonce'] = time();
// create the signature
$signature = hash_hmac('sha256', json_encode($commands), $api_secret);
// add signature to request parameters
$commands['signature'] = $signature;# Python Example
import hashlib
import hmac
// we add our public key and nonce to whatever parameters we are sending
params = {'currency': 'eur', 'price': 200, 'api_key': api_key, 'nonce': time.time()}
// create the signature
message = bytes(json.dumps(params)).encode('utf-8')
secret = bytes(api_secret).encode('utf-8')
signature = hmac.new(secret, message, digestmod=hashlib.sha256).hexdigest()
// add signature to request parameters
params['signature'] = signature // C# Example
using System.Security.Cryptography;
// we add our public key and nonce to whatever parameters we are sending
var params1 = new List>();
params1.Add(new KeyValuePair("api_key", api_key));
params1.Add(new KeyValuePair("nonce", (Int32)(DateTime.UtcNow.Subtract(new DateTime(1970, 1, 1))).TotalSeconds));
// create the signature
JavaScriptSerializer serializer = new JavaScriptSerializer();
var message = serializer.Serialize(params1);
secret = secret ?? "";
var encoding = new System.Text.ASCIIEncoding();
byte[] keyByte = encoding.GetBytes(secret);
byte[] messageBytes = encoding.GetBytes(message);
using (var hmacsha256 = new HMACSHA256(keyByte))
{
byte[] hashmessage = hmacsha256.ComputeHash(messageBytes);
var signature = BitConverter.ToString(hashmessage);
signature = signature.Replace("-", "");
// add signature to request parameters
params1.Add(new KeyValuePair("signature", signature));
}/* Java Example */
/* Dependent on Apache Commons Codec to encode in base64. */
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import org.apache.commons.codec.binary.Hex;
/* we add our public key and nonce to whatever parameters we are sending */
Map params = new HashMap();
params.put("api_key", "demo");
params.put("nonce", ((int) (System.currentTimeMillis() / 1000L)));
/* create the signature */
String secret = "secret";
String message = new JSONObject(params).toString();
Mac sha256_HMAC = Mac.getInstance("HmacSHA256");
SecretKeySpec secret_key = new SecretKeySpec(secret.getBytes(), "HmacSHA256");
sha256_HMAC.init(secret_key);
String hash = Hex.encodeHexString(sha256_HMAC.doFinal(message.getBytes()));
/* add signature to request parameters */
params.put("signature", hash);
Балансы и Информация
Получить балансы аккаунтов и уровни сборов:
POST https://getbtc.org/api/balances-and-info
Ответ:
on_hold[currency][withdrawal] (float) – Количество валюты для снятия по состоянию на текущий момент времени.
on_hold[currency][order] (float) - Количество валюты на ваших открытых заявках.
on_hold[currency][total] (float) - Общая сумма валюты, которая находится на удержании - сумма последних двух пунктов.
available[currency] (float) - Количество валюты, которая доступна в настоящее время.
usd_volume (float) - 30-дневный объем торговли вашей учетной записи, преобразованный в значение в долларах США.
fee_bracket[maker] (float) - Уровень платежа за транзакцию аккаунта (в процентах), если не инициирует транзакцию (т.е. выступает в качестве производителя).
fee_bracket[taker] (float) - Уровень платежа за транзакцию аккаунта (в процентах), если не инициирует транзакцию (т.е. выступает в качестве приобретателя).
global_btc_volume (float) –Обмен всего 24-часового объема транзакций в Биткоин.
Открытые Заявки
Для получения текущих открытых заявок аккаунта, которые сгруппированы по стороне заказа (bid или ask).
POST https://getbtc.org/api/open-orders
Параметры:
currency (string) - Код валюты в формате USD/EUR/RUB. Будет включен фильтр по заявкам именно этой валюты. Если этот параметр пропущен, на экран выведутся все открытые заявки.
Ответ:
id (int) - Уникальный идентификатор заявки.
side (string) - "buy" или "sell".
type (string) - "market", "limit" или "stop".
amount (float) - Сумма первоначальной заявки в BTC.
amount_remaining (float) - Сумма, которая еще не была заполнена в BTC.
price (float) - Текущая цена заявки в вашей национальной валюте.
avg_price_executed (float) - Средневзвешенная цена, по которой заявка была заполнена, в национальной валюте. Ответ 0 – сделки еще не сгенерированы.
stop_price (float) –Цена, при которой будет срабатывать стоп, если есть заявка стоп-ордер.
currency (string) - Национальная валюта заявки.
status (string) - Текущий статус заявки. Возможные значения 'ACTIVE','FILLED','CANCELLED_USER','OUT_OF_FUNDS','REPLACED'.
replaced (int) - Если заявка была отредактирована, она замещается.
replaced_by (int) - Если заявка была заменена, id заявки замещается.
Сделки Пользователей
Команда возвращает список транзакций учетной записи, которые упорядочены по дате. Вывод производится в порядке убывания.
POST https://getbtc.org/api/user-transactions
Параметры:
currency (string) - Код валюты в формате 3 - х букв. Происходит фильтр по транзакциям, включающим именно эту валюту. Если значение пропущено, то все транзакции будут выведены на экран.
limit (int) - Количество транзакций на возврат.
side (string) - Фильтры сделок по типу ("buy" или "sell").
Ответ:
id (int) - Уникальный идентификатор транзакции.
date (string) - Дата в формате YYYY-MM-DD.
btc (float) - Сумма транзакции в BTC.
side (string) – Может быть "buy" или "sell".
price (float) – Цена, по которой была произведена транзакция, в национальной валюте.
amount (float) – Сумма транзакции в национальной валюте.
fee (float) - Платеж за транзакцию в национальной валюте.
currency (string) - Валюта , в которой была произведена транзакция.
Существующие Биткойн Адреса Для Депозита
Получить список существующих адресов учетной записи для получения биткоинов.
POST https://getbtc.org/api/btc-deposit-address/get
Параметры:
limit (int) - Количество адресов для возврата.
Ответ:
address (string) - Адрес для ввода биткоинов.
date (string) - Строка даты в формате YYYY-MM-DD HH:MM:SS.
Получить Новые Биткойн Адреса Для Депозита
Для получения новых биткоин-адресов для вашего аккаунта:
POST https://getbtc.org/api/btc-deposit-address/new
Ответ:
address (string) – Новые адреса для внесения Bitcoin.
Получить Депозиты
С помощью этой команды вы можете получить список депозитов (BTC или fiat) внесенных на счет. Они упорядочены по дате в порядке убывания.
POST https://getbtc.org/api/deposits/get
Параметры:
currency (string) - Код валюты в трехбуквенном формате. Происходит фильтрация по депозитам, включающим эту валюту. Если значение пропущено – на экран выводятся все депозиты.
limit (int) - Количество депозитов к возврату.
status (string) – Фильтры депозитов со статусом ("pending", "completed" или "cancelled").
Ответ:
id (int) - Уникальный идентификатор для депозита.
date (string) - Дата YYYY-MM-DD HH:MM:SS.
currency (string) – Валюта депозита.
amount (float) – Сумма депозита, в валюте ввода.
status (string) – Текущий статус транзакции. Возможные значения: "PENDING", "COMPLETED" или "CANCELLED".
account_number (int) – Номер аккаунта, с которого был совершен депозит (активно только для фиатных депозитов).
address (string) - Bitcoin адрес, с которого был совершен депозит (активно только для BTC депозитов).
Получить Вывод
Вы можете получить список всех выводов (BTC или fiat) с вашего счета. Они упорядочены по дате, в порядке убывания.
POST https://getbtc.org/api/withdrawals/get
Параметры:
currency (string) - Код валюты в трехбуквенном формате. Фильтрует по выводам, включающим эту валюту. Если значение отсутствует, все выводы будут выведены на экран.
limit (int) – Сумма всех выводов к возврату.
status (string) – Фильтры вывода со статусом ("pending", "completed" или "cancelled").
Ответ:
id (int) - Уникальный идентификатор для вывода.
date (string) — Дата в формате YYYY-MM-DD HH:MM:SS.
currency (string) – Валюта вывода.
amount (float) – Сумма вывода, в валюте вывода.
status (string) - Текущий статус вашей транзакции. Значения: "PENDING", "COMPLETED" или "CANCELLED".
account_number (int) – Номер аккаунта на который был сделан вывод (только для fiat вывода).
address (string) – Bitcoin - адрес, на который был сделан вывод (актуально только для BTC выводов).
Разместить Одну (или Несколько) Новых Заявок
С помощью этой команды возможно поместить одну или несколько новых заявок с вашего счета. Чтобы разместить несколько заявок, вы можете отправить многомерный массив с именем заявки. Массив должен содержать все параметры в каждом из элементов массива, как указано ниже в примере.
POST https://getbtc.org/api/orders/new
Параметры:
side (string) – Может быть "buy" или "sell".
type (string) – Может быть "market", "limit" или "stop". "stop" заявки могут содержать как stop_price, так и limit_price - они будут обработаны в OCO виде (One Cancels the Other-исполнение одной заявки отменяет другую или взаимоотменяющие заявки).
currency (string) - Код валюты в трехбуквенном формате. Валюта, в которой будет сделана заявка.
limit_price (float) - Предельная цена для заявки, в валюте заявки.
stop_price (float) - Стоп-цена для заявки, в валюте заявки. "Stop" заявка может иметь и stop и limit цены, как описано в "type ".
amount (float) - Количество BTC для покупки или продажи.
orders (array) - Этот параметр используется, только если Вы намереваетесь разместить многократные заявки в одном запросе API. Это должен быть массив или JSON строка, содержащая все предыдущие параметры для каждого элемента, такие как заявки [n] = ['side'=>x,'type'=>y,...]. Это может быть как простой массив HTTP параметров, так и может быть отформатировано как JSON.
Ответ:
transactions (int) - Количество сделок которые произошли после размещения вашей заявки.
new_order (int) – Количество новых размещенных заказов (возвращает 2, если стоп-ордер имеет как limit_price, так и stop_price).
id (int) - Уникальный идентификатор вывода.
side (string) – Может быть "buy" или "sell".
type (string) – Может быть "market", "limit" или "stop".
amount (float) – Оригинальная сумма BTC для продажи или покупки.
amount_remaining (float) - Непогашенная сумма BTC (в процессе выполнения) по заявке.
price (float) - Текущая цена заявки в родной валюте.
avg_price_executed (float) - Средневзвешенная из цен, по которым заявка была заполнена, в ее валюте. Возврат ноля означает, что он еще не генерируется никаких сделок.
stop_price (float) - Если есть заявка стоп-ордер, цена, при которой будет срабатывать стоп.
currency (string) – Национальная валюта заявки.
status (string) - Текущий статус заявки. Диапазон возможных значений: 'ACTIVE','FILLED','CANCELLED_USER','OUT_OF_FUNDS','REPLACED'.
oco (boolean) - Если стоп-ордер имеет и стоп и лимит цены, значением будет true.
Редактировать Одну (или Несколько) Заявок
Можно изменить одну или несколько заявок, которые вы разместили. Чтобы изменить несколько заявок, вы можете отправить многомерный массив, называемый «заявки», который должен содержать все параметры в каждом элементе массива, как указано ниже в примере:
POST https://getbtc.org/api/orders/edit
Параметры:
id (int) - Уникальный идентификатор заявки, которую вы собираетесь редактировать.
type (string) - Может быть "market", "limit" или "stop". "stop" заявки могут содержать как stop_price, так и limit_price - они будут обработаны в OCO виде (One Cancels the Other-исполнение одной заявки отменяет другую или взаимоотменяющие заявки).
limit_price (float) - Предельная цена для заявки, в валюте заявки.
stop_price (float) - Стоп-цена для заявки, в валюте заявки. "Stop" заявка может иметь и stop и limit цены, как описано в " type ".
amount (float) - Сумма BTC для продажи или покупки.
orders (array) - Этот параметр используется в случаях, если Вы собираетесь разместить многократные заявки в одном запросе API. Это должен быть массив или JSON строка, содержащая все предыдущие параметры для каждого элемента, такие как заявки[n] = ['id'=>x,'type'=>y,...]. Это может быть простым массивом HTTP параметров или может быть отформатировано как JSON.
Ответ:
transactions (int) - Количество сделок, которые произошли после редактирования заявки.
edit_order (int) - Количество новых размещенных заявок (возвращает 2, если стоп-приказ содержит как limit_price так и stop_price).
id (int) - Новый id для заявки (в предыдущей заявке id будет отмечен "REPLACED"). Это позволяет отслеживать любые пользовательские изменения к заявке.
side (string) - Может быть "buy" или "sell".
type (string) -Может быть "market", "limit" или "stop".
amount (float) - Количество BTC, оставшееся в заявке во время редактирования.
amount_remaining (float) - Непогашенная сумма BTC (но должно быть выполнено) по заявке.
price (float) - Текущая цена заявки в своей родной валюте.
avg_price_executed (float) - Средневзвешенная из цен, по которым заявка была заполнена, в ее валюте. Ноль означает, что он еще не генерируется никаких сделок.
stop_price (float) - Если есть заявка стоп-ордер, цена, при которой будет срабатывать стоп.
currency (string) - Валюта заявки.
status (string) - Текущий статус заявки. Возможные значения 'ACTIVE','FILLED','CANCELLED_USER','OUT_OF_FUNDS','REPLACED'.
replaced (int) - Заявка заменит указанную.
oco (boolean) - Если стоп-ордер имеет стоп и лимит цены, возвращает true.
Отменить Одну, Многие или Все заявки
С помощью этой команды возможно отменить одну или несколько активных заявок. Чтобы отменить несколько заказов, вы можете отправить многомерный массив называемый orders, который должен содержать все параметры в каждом элементе массива, как указано ниже. Чтобы отменить ВСЕ заявки, просто отправьте параметр, называемый all.
POST https://getbtc.org/api/orders/cancel
Параметры:
id (int) - Уникальный идентификатор заявки, которую вы хотите редактировать.
orders (array) - Этот параметр используется, только если вы намерены получить статус нескольких заявок в одном вызове API. Он должен быть массивом или строкой JSON, содержащей параметр id для каждого элемента, например, как такие заявки [n] = ['id' => x]. Это может быть простой массив параметров HTTP, или может быть отформатирован как JSON.
all (bool)- Отправка этого параметра отменит ВСЕ заявки. Будьте осторожны!
Ответ:
id (int) – Уникальный идентификатор заявки.
side (string) – Может быть "buy" или "sell".
type (string) – Может быть"market", "limit" или "stop".
amount (float) - Первоначальная сумма BTC, когда заявка была размещена или отредактирована.
amount_remaining (float) – Непогашенная сумма BTC (но должно быть выполнено) по заявке.
price (float) - Текущая цена заявки в национальной валюте.
avg_price_executed (float) - Средневзвешенная из цен, по которой заявка была заполнена, в ее валюте. Если возвращен ноль – это значит, что в данный момент не генерируется никаких операций.
stop_price (float) - Если есть заявка стоп-ордер, возвращает цену, при которой будет срабатывать стоп.
currency (string) – Валюта заявки.
status (string) - Текущий статус заявки. Возможные значения 'ACTIVE','FILLED','CANCELLED_USER','OUT_OF_FUNDS','REPLACED'.
replaced (int) - Заявка заменит эту, если была отредактирована.
replaced_by (int) – Заявка, которая заменит эту, если "REPLACED".
Статус Одной (или Нескольких) Заявок
Эта команда поможет вам получить текущее состояние одной или нескольких заявок, которые были размещены на счету. Для получения нескольких заявок, необходимо отправить многомерный массив, именуемый заявки, который должен содержать все параметры в каждом элементе массива, как указано ниже в примере.
POST https://getbtc.org/api/orders/status
Параметры:
id (int) - Уникальный идентификатор заявки, которую вы собираетесь редактировать.
orders (array) - Этот параметр используется, только если вы намерены получить статус нескольких заявок в одном вызове API. Он должен быть массивом или строкой JSON, содержащей параметр id для каждого элемента, например, как такие заявки [n] = ['id' => x]. Это может быть простой массив параметров HTTP, или он может быть отформатирован как JSON.
Ответ:
id (int) – Уникальный идентификатор заявки.
side (string) – Может быть "buy" или "sell".
type (string) – Может быть"market", "limit" или "stop".
amount (float) - Первоначальная сумма BTC, в момент, когда заявка была размещена или отредактирована.
amount_remaining (float) – Непогашенная сумма BTC (в процессе выполнения) по заявке.
price (float) - Текущая цена заявки в национальной валюте.
avg_price_executed (float) - Средневзвешенная из цен, по которой заявка была заполнена, в ее валюте. Ноль означает, что еще не генерируется никаких операций.
stop_price (float) - Если есть заявка стоп-ордер, возвращает цену, при которой будет срабатывать стоп.
currency (string) – Валюта заявки.
status (string) - Текущий статус заявки. Возможные значения 'ACTIVE','FILLED','CANCELLED_USER','OUT_OF_FUNDS','REPLACED'.
replaced (int) - Заявка заменит эту, если была отредактирована.
replaced_by (int) – Заявка, которая заменит эту, если "REPLACED".
Сделать Вывод Средств
Команда используется для выведения средств из аккаунта на существующий Bitcoin - адрес или банковский fiat счет. Обращаем внимание: Вы должны привязать желаемый номер банковского счета к своей учетной записи на странице банковских счетов для того, чтобы эта функция работала. В противном случае, операция снятия не будет успешной.
POST https://getbtc.org/api/withdrawals/new
Параметры:
currency (string) - Код валюты в формате USD/EUR/RUB/BTC, которую вы намерены снять. Значение должно совпадать с валютой на счете, если вы снимаете fiat-валюту.
amount (float) - Сумма, которую необходимо снять (в приведенной выше валюте).
address (string) – Для вывода BTС. Bitcoin адрес, по которому вы хотите вывести.
account_number (int) – Для вывода фиатных денег. Номер банковского счета, на который Вы планируете вывести валюту.
Ответ:
id (int) – Уникальный идентификатор для вывода.
date (string) - Дата в формате YYYY-MM-DD HH:MM:SS.
currency (string) – Валюта вывода.
amount (float) – Сумма вывода, в валюте вывода.
status (string) - Текущий статус сделки. Может быть"PENDING", "COMPLETED" или "CANCELLED".
account_number (int) - Номер счета, на который был сделан вывод (только для вывода fiat).
address (string) - Адрес Bitcoin, на который был сделан вывод (только для вывода BTC).