Adresy związane z API

Wszystkie parametry należy wysłać w zapytaniu GET.

We wszystkich zapytaniach do API, parametry base_currency i additional_currency oznaczają odpowiednio walutę dłużną (np. PLN) i walutę kryptograficzną (np. BTC). Jest to odpowiednik instancji CurrencyPair(additional_currency, base_currency) z interfejsu XChange.

Odpowiedź jest obiektem JSON. Zawsze zawiera conajmniej jeden klucz status. Jeżeli status == 'ok' to właściwą odpowiedź można znaleźć pod kluczem result. Formaty poszczególnych odpowiedzi zostały przedstawione w poniższej tabeli.

UWAGA: To, że api zwraca status == 'ok' nie oznacza, że zlecenie zostało wpisane lub usunięte z księgi zleceń. Oznacza to jedynie, że zostało poprawnie przyjęte do kolejki zadań i zostanie w najbliższym czasie przetworzone przez podsystem rynkowy. W trakcie obsługi zadania mogą się pojawić błędy (np. brak środków na koncie). Aby sprawdzić jaki jest aktualny status zlecenia należy użyć adresu /api/order-status/.

Pobierz kod źródłowy obrazujący wykorzystanie api bitstar.

URLNazwaOpisOdpowiedź
/api/Lista adresów (ta strona)
/api/token/Token i klucz prywatny
/api/ticker/ Aktualny stan giełdy base_currency=«CURRENCY»
additional_currency=«CURRENCY»
// Wszystkie wartości są ceną za 1 «additional_currency».
{
    "last": «DECIMAL»,  // Cena z ostatniej transakcji.
    "open": «DECIMAL»,  // Cena z ostatniej transakcji w czasie otwarcia giełdy z godziny 00:00.
    "min": «DECIMAL»,  // Najniższa cena osiągnięta dzisiaj.
    "max": «DECIMAL»  // Najwyższa cena osiągnięta dzisiaj.
}
            
/api/fee-schedule/ Aktualne prowizje base_currency=«CURRENCY»
[
 // [Próg prowizji, Prowizja w %]
    [«DECIMAL», «DECIMAL»],
    [«DECIMAL», «DECIMAL»],
    [«DECIMAL», «DECIMAL»],
                ...
]
            
/api/order-book/ Księga zleceń currency_from=«CURRENCY» // Należy traktować jak «base_currency» czyli walutę dłużną.
currency_to=«CURRENCY» // Należy traktować jak «additional_currency» czyli walutę kryptograficzną.
{
    "buy": [
        {
            "available": «DECIMAL»,
            "currency_from": «CURRENCY»,
            "currency_to": «CURRENCY»,
            "price": «DECIMAL»
        },
        ..
    ],
    "sell": [
        {
            "available": «DECIMAL»,
            "currency_from": «CURRENCY»,
            "currency_to": «CURRENCY»,
            "price": «DECIMAL»
        },
        ..
    ]
}
/api/transactions/ Transakcje currency=«CURRENCY»
[
    {
        "amount": «DECIMAL»,
        "price": «DECIMAL»,
        "currency_from": «CURRENCY»,
        "currency_to": «CURRENCY»,
        "created_at": «UTCTIMESTAMP»
    },
    ..
]

Zapytania wymagające autentykacji.

URLNazwaOpisOdpowiedź
/api/balance/ Bilans konta key=«KEY»
nonce=«NONCE»
signature=«SIGNATURE»
currency=«CURRENCY»
«DECIMAL»
/api/freezed/ Środki zablokowane w otwarty zleceniach key=«KEY»
nonce=«NONCE»
signature=«SIGNATURE»
currency=«CURRENCY»
{
    «CURRENCY»: «DECIMAL»
}
/api/cancel-order/ Anulowanie zlecenia key=«KEY»
nonce=«NONCE»
signature=«SIGNATURE»
order_id=«ORDERID»
/api/order-status/ Zapytanie o status zlecenia key=«KEY»
nonce=«NONCE»
signature=«SIGNATURE»
order_id=«ORDERID» (ten parametr może być powtórzony n-krotnie, by odpytać o więcej zleceń jednocześnie)
// przykładowe zapytanie o zlecenia o numerach 1, 2 i 3:
// /api/order-status/?nonce=1448310644&order_id=1&order_id=2&order_id=3&signature=44C6A0B1E6E61854BA9F40E57C15766F1B4D6563434D3C1C69D8ECE89602D72F&key=9014167084%3AS59Y06mzrjATD0Q3tR27juIfvAfsXW4Z6w38
{
    «ORDER_ID»: {
        'status': «new/processing/done/rejected»,
        // new - zlecenie przyjęte do kolejki i oczekujące na obsłużenie
        // processing - zlecenie obsługiwane przez kolejkę
        // done - zlecenie obsłużone przez kolejkę (np. dopisane do księgi zleceń jeśli dot. złożenia oferty)
        // rejected - zlecenie odrzucone w trakcie obsługiwania przez kolejkę
        'summary': {
            'order': {
                // SEE: /api/open-orders/
            },
            'trades': [
                // SEE: /api/user-transactions/
            ],
    },
    ..
}
            
/api/place-order/ Złóż zlecenie giełdowe key=«KEY»
nonce=«NONCE»
signature=«SIGNATURE»

base_currency=«CURRENCY»
additional_currency=«CURRENCY»
operation=«BID/ASK» // BID - kupno kryptowaluty; ASK - sprzedaż kryptowaluty.
amount=«DECIMAL»
/api/place-order-limit/ Złóż zlecenie z limitem key=«KEY»
nonce=«NONCE»
signature=«SIGNATURE»

base_currency=«CURRENCY»
additional_currency=«CURRENCY»
operation=«BID/ASK» // BID - kupno kryptowaluty; ASK - sprzedaż kryptowaluty.
amount=«DECIMAL»
price=«DECIMAL»
«ORDER_ID»
/api/user-transactions/ Transakcje użytkownika key=«KEY»
nonce=«NONCE»
signature=«SIGNATURE»
[
    {
        'base_currency': «CURRENCY»,
        'additional_currency': «CURRENCY»,
        'id': «TRANSACTION_ID»,
        'order_id': «ORDER_ID»,
        'order_type': «BID/ASK»  // BID - kupno kryptowaluty; ASK - sprzedaż kryptowaluty.,
        'amount': «DECIMAL»,
        'price': «DECIMAL»,
        'timestamp': «UTCTIMESTAMP»
    },
    ..
]
/api/open-orders/ Księga zleceń key=«KEY»
nonce=«NONCE»
signature=«SIGNATURE»
[
    {
        'base_currency': «CURRENCY»,
        'additional_currency': «CURRENCY»,
        'id': «ORDER_ID»,
        'order_type': «BID/ASK»  // BID - kupno kryptowaluty; ASK - sprzedaż kryptowaluty.,
        'tradable_amount': «DECIMAL»,
        'price': «DECIMAL»,
        'timestamp': «UTCTIMESTAMP»
    },
]
            

Zestawienie adresów bitstar z interfejsem XChange

CurrencyPair(BTC, PLN)base_currency=PLN additional_currency=BTC
PollingTradeService.getOpenOrders()/api/open-orders/
PollingTradeService.placeMarketOrder()/api/place-order/
PollingTradeService.placeLimitOrder()/api/place-order-limit/
PollingTradeService.cancelOrder()/api/cancel-order/
PollingTradeService.getTradeHistory()/api/user-transactions/

Strona korzysta z plików cookie w celu realizacji usług zgodnie z Polityką prywatności. Możesz określić warunki przechowywania lub dostępu do cookie w Twojej przeglądarce lub konfiguracji usługi.

X

Projekt współfinansowany z Europejskiego Funduszu Rozwoju Regionalnego w ramach
Programu Operacyjnego Innowacyjna Gospodarka na lata 2007-2013