Dane rynkowe

Przegląd REST

Bazowy URL, uwierzytelnianie, format odpowiedzi i błędy dla REST API danych rynkowych.

Przegląd

REST API danych rynkowych zapewnia dostęp do listingów przedmiotów, zleceń kupna, historii cen i danych sprzedaży z zewnętrznych marketplace'ów Steam. Jest to osobna usługa od głównego Steam API i działa na własnym hoście.

To API dokumentuje transport REST. Dla strumienia w czasie rzeczywistym zobacz WebSocket. Oba transporty korzystają z tych samych marketplace'ów — zobacz Referencja.

Bazowy URL

Wszystkie endpointy REST są obsługiwane z jednego hosta.

https://marketplaceapi.steamapis.com/v2/

Uwierzytelnianie

Dołącz swój klucz API jako nagłówek żądania X-API-Key. Nagłówki HTTP nie uwzględniają wielkości liter, więc x-api-key również działa.

X-API-Key: YourSecretAPIKey

Alternatywnie przekaż klucz jako parametr zapytania apiKey. Nagłówek jest preferowany.

https://marketplaceapi.steamapis.com/v2/marketplaces?apiKey=YourSecretAPIKey

Format odpowiedzi

Odpowiedzi są płaskim JSON-em. W przeciwieństwie do Steam API, to API nie opakowuje odpowiedzi w kopertę { "success": true, "response": {...} }. Parsuj treść odpowiedzi bezpośrednio.

Udana odpowiedź to pojedynczy obiekt lub tablica obiektów, w zależności od endpointu. Na przykład GET /v2/marketplaces zwraca tablicę bezpośrednio na najwyższym poziomie treści.

Błędy

Błędy są zwracane ze statusem HTTP innym niż 2xx i treścią JSON zawierającą wiadomość error oraz czytelny maszynowo code.

error.json
{
  "error": "Marketplace not found",
  "code": "NOT_FOUND"
}

Cache'owanie i limity żądań

Odpowiedzi są cache'owane po stronie serwera przez 10 sekund. Nie ma limitów po stronie klienta — cache absorbuje powtarzający się ruch.

Dostępne endpointy