Dokumentacja narzędzia orderbook
Ta strona jest dokumentacją narzędzia do pobierania migawek księgi zleceń z Cryptohopper Market Data MCP. Aby zapoznać się z przewodnikiem koncepcyjnym, zobacz praktyczny przewodnik po danych księgi zleceń kryptowalut.
Nazwa narzędzia
get_orderbook
Cel
Zwraca migawkę księgi zleceń w danym momencie dla określonej pary na określonej giełdzie. Zawiera aktualne oferty kupna i sprzedaży z ceną i wielkością na poziom.
Argumenty
| Argument | Typ | Wymagane | Opis |
|---|---|---|---|
| exchange | string | Tak | Identyfikator giełdy (małe litery). |
| pair | string | Tak | Para w formacie BASE/QUOTE (np. BTC/USDT). |
| depth | integer | Nie | Maksymalna liczba poziomów do zwrócenia na stronę. Domyślnie zależy od giełdy. Górna granica zależy od źródła danych. |
Schemat odpowiedzi
{
"exchange": "binance",
"pair": "BTC/USDT",
"timestamp": "2026-04-24T14:03:00Z",
"bids": [
[80934.18, 5.32816],
[80930.05, 1.10000],
[80925.40, 3.40000]
],
"asks": [
[80936.22, 1.20000],
[80940.00, 2.50000],
[80945.75, 0.80000]
]
}
Pola
| Pole | Typ | Opis |
|---|---|---|
| exchange | string | Identyfikator giełdy, z której pochodzą dane. |
| pair | string | Para w formacie BASE/QUOTE. |
| timestamp | string (ISO-8601) | Czas przechwycenia migawki. |
| bids | array | Tablica krotek [cena, wielkość], posortowana według ceny malejąco (najwyższa oferta pierwsza). |
| asks | array | Tablica krotek [cena, wielkość], posortowana według ceny rosnąco (najniższa oferta pierwsza). |
Ceny i wielkości są zwracane jako liczby JSON. Klienci, którzy wymagają dokładnej precyzji do obliczeń związanych z wykonaniem, powinni konwertować je na typ dziesiętny natychmiast po parsowaniu. Zobacz model danych dla konwencji.
Kolejność
- bids są posortowane malejąco według ceny. Pierwszy wpis to najlepsza oferta (najwyższa cena oferowana przez kupującego).
- asks są posortowane rosnąco według ceny. Pierwszy wpis to najniższa oferta (najniższa cena oferowana przez sprzedającego).
Spread to różnica między asks[0] a bids[0]. Punkt środkowy to ich średnia.
Głębokość
Głębokość księgi zleceń różni się w zależności od giełdy. MCP zwraca to, co giełda źródłowa udostępnia przez swoje publiczne API.
| Typowa głębokość (poziomy na stronę) | Giełdy |
|---|---|
| 100 | Większość głównych giełd domyślnie |
| Do 500 lub więcej | Niektóre giełdy, gdy jest żądana głębokość |
Żądania większej głębokości niż obsługuje źródło są ograniczane do maksimum źródła. Argument głębokości jest próbą, nie gwarancją.
Aktualność
Księgi zleceń są przechwytywane w momencie żądania. Pole timestamp odzwierciedla moment, w którym migawka została odczytana z giełdy źródłowej.
Księgi zleceń bardzo szybko się dezaktualizują — zazwyczaj w ciągu sekund na płynnych parach. Klienci nie powinni buforować odpowiedzi księgi zleceń do użycia w decyzjach o wykonaniu.
Koszt
| Aspekt | Koszt |
|---|---|
| Na wywołanie | 1 jednostka wywołania na wszystkich poziomach |
| Wariant historyczny | Nieobsługiwany — historia księgi zleceń nie jest dostępna przez MCP |
Przykładowe wywołania
Podstawowy zrzut
Zapytane w kliencie MCP:
Pokaż mi aktualną księgę zleceń dla BTC/USDT na Binance.
Agent wywołuje get_orderbook(exchange="binance", pair="BTC/USDT") i zwraca migawkę.
Niestandardowa głębokość
Pobierz 50 najlepszych poziomów księgi zleceń ETH/USDT na Kraken.
Agent wywołuje get_orderbook(exchange="kraken", pair="ETH/USDT", depth=50).
Metryki pochodne
MCP zwraca surowe poziomy; metryki pochodne (spread, głębokość w ramach X%, poślizg dla danej wielkości zlecenia) są obliczane przez model lub kod wywołujący.
Błędy
| Kod błędu | Przyczyna |
|---|---|
| UNAUTHORIZED | Klucz API nieprawidłowy lub odwołany. |
| EXCHANGE_NOT_SUPPORTED | Giełda niedostępna na aktywnym poziomie. |
| PAIR_NOT_FOUND | Para nie istnieje na określonej giełdzie. |
| INVALID_PARAMETER | Argument nie przeszedł walidacji (np. źle sformatowany symbol pary, ujemna głębokość). |
| EXCHANGE_UNAVAILABLE | Giełda źródłowa nie odpowiada. |
| RATE_LIMIT_EXCEEDED | Osiągnięto limit szybkości w krótkim interwale. |
| QUOTA_EXCEEDED | Osiągnięto tygodniowy limit. |
Dostęp według poziomu
Zapytania księgi zleceń są dostępne na wszystkich poziomach (Pioneer, Explorer, Adventurer, Hero).
Obowiązuje ograniczenie zakresu giełd: na poziomie Pioneer zapytania księgi zleceń są ograniczone do Binance, Coinbase i Kraken. Na poziomie Explorer i wyższych dostępnych jest więcej giełd.