API BitBay zostało zaprojektowane w celu udzielenia wygodnego dostępu do zasobów serwisu w zakresie pobierania danych oraz wykonywania operacji przy użyciu oprogramowania zewnętrznego. Z łatwością może zostać użyte do tworzenia dynamicznych wykresów ze statystykami dowolnych rynków, czy zaprojektowania autonomicznej aplikacji grającej na giełdzie.

Jeżeli podczas przeglądania dokumentacji zauważyłeś błąd lub masz ciekawe sugestie dotyczące funkcjonalności i rozbudowy, skontaktuj się z nami poprzez formularz kontaktowy.

Adres bazowy, pod którym dostępne jest API: https://api.bitbay.net/rest

W niniejszej dokumentacji, dla uproszczenia wszystkie endpointy będą nazywane metodami.
Wywołanie konkretnej metody, np. dostęp do tickera (szczegóły zostaną opisane w dalszej części) będzie wyglądać następująco: https://api.bitbay.net/rest/trading/ticker

Wszystkie parametry czasowe zwracane przez API są w formacie UNIX timestamp z dokładnością do milisekund.
Zapytania muszą zawierać nagłówek Content-type: application/json, w innym przypadku mogą zostać niepoprawnie przetworzone.

Ponieważ wszystkie odpowiedzi są zwracane z kodem "200 OK" - każda metoda zwraca w odpowiedzi swój status wykonania.
W przypadku niepoprawnego wykonania - w odpowiedzi zostanie zwrócony status: Fail oraz w odpowiedzi pojawi się dodatkowy parametr errors, zawierający tablicę z komunikatami o błędach.