Dokumentacja referencyjna API
Dokumentacja API
Interfejs JSON API tylko do odczytu, oparty na tych samych danych rynkowych, które pokazuje ta strona. Odpowiedzi sukcesu używają koperty { data, meta }; odpowiedzi błędów używają { error: { code, message } }.
- Bazowy URL
- http://localhost:3000
- Metody
- Tylko GET
- Format
- JSON, UTF-8
- Limit zapytań
- 60 zapytań na 60 sekund, na adres IP i punkt końcowy
These are API examples. This site is served as static files.
MARKET_DATA_PROVIDER=fmp wraz z FMP_API_KEY. Pole meta.provider w każdej odpowiedzi wskazuje, które źródło odpowiedziało.Lista notowań
/api/quotesZwraca jedną stronę instrumentów jako płaską tablicę, a w meta znajdują się total, page i pageSize. Wszystkie filtry skanera poniżej działają również tutaj; wartości, których nie można odczytać, są ignorowane.
Parametry
| Parametr | Gdzie | Typ | Wymagany | Opis |
|---|---|---|---|---|
| sector | query | string | Opcjonalny | Dokładna nazwa sektora: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate. |
| sort | query | string | Opcjonalny | Pole sortowania: marketCap (domyślnie), price, changePercent, volume lub symbol. |
| order | query | string | Opcjonalny | Kolejność sortowania: desc (domyślnie) lub asc. |
| page | query | number | Opcjonalny | Numer strony, począwszy od 1. |
| pageSize | query | number | Opcjonalny | Wierszy na stronę: domyślnie 20, maksymalnie 100. |
Zapytanie
curl -s "http://localhost:3000/api/quotes?pageSize=3"Przykładowa odpowiedź
200application/json
{
"data": [
{
"symbol": "NWRB",
"name": "Northwind Robotics",
"exchange": "NASDAQ",
"sector": "Technology",
"industry": "Industrial Automation",
"price": 733.8,
"change": -16.52,
"changePercent": -2.2,
"previousClose": 750.32,
"open": 750.03,
"dayHigh": 751.29,
"dayLow": 731.5,
"volume": 3471317,
"avgVolume": 2962633,
"marketCap": 982258754565,
"peRatio": 60.35,
"eps": 12.16,
"dividendYield": null,
"week52High": 963.99,
"week52Low": 583.89,
"afterHoursPrice": 731,
"afterHoursChangePercent": -0.38,
"updatedAt": "2026-11-12T21:00:00.000Z"
}
],
"meta": {
"provider": "demo",
"generatedAt": "2026-11-12T21:00:04.512Z",
"disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
"total": 20,
"page": 1,
"pageSize": 3
}
}Przykład skrócono do jednego wiersza.
Pobierz notowanie
/api/quotes/{symbol}Zwraca pełne notowanie jednego instrumentu lub indeksu. Nieznany symbol zwraca 404 not_found.
Parametry
| Parametr | Gdzie | Typ | Wymagany | Opis |
|---|---|---|---|---|
| symbol | path | string | Wymagany | Symbol instrumentu lub indeksu, na przykład NWRB. Wielkość liter nie ma znaczenia. |
Zapytanie
curl -s "http://localhost:3000/api/quotes/NWRB"Przykładowa odpowiedź
200application/json
{
"data": {
"symbol": "NWRB",
"name": "Northwind Robotics",
"exchange": "NASDAQ",
"sector": "Technology",
"industry": "Industrial Automation",
"price": 733.8,
"change": -16.52,
"changePercent": -2.2,
"previousClose": 750.32,
"open": 750.03,
"dayHigh": 751.29,
"dayLow": 731.5,
"volume": 3471317,
"avgVolume": 2962633,
"marketCap": 982258754565,
"peRatio": 60.35,
"eps": 12.16,
"dividendYield": null,
"week52High": 963.99,
"week52Low": 583.89,
"afterHoursPrice": 731,
"afterHoursChangePercent": -0.38,
"updatedAt": "2026-11-12T21:00:00.000Z"
},
"meta": {
"provider": "demo",
"generatedAt": "2026-11-12T21:00:04.512Z",
"disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice."
}
}Pobierz świece
/api/candles/{symbol}Zwraca świece OHLCV, od najstarszej. Zakres 1D używa interwałów 30-minute; każdy inny zakres używa świec dziennych. Nieznany zakres zwraca 400 bad_request.
Parametry
| Parametr | Gdzie | Typ | Wymagany | Opis |
|---|---|---|---|---|
| symbol | path | string | Wymagany | Symbol instrumentu lub indeksu, na przykład NWRB. Wielkość liter nie ma znaczenia. |
| range | query | string | Opcjonalny | Jedna z wartości 1D, 5D, 1M, 6M, 1Y, 5Y. Domyślnie 1M. |
Zapytanie
curl -s "http://localhost:3000/api/candles/NWRB?range=1M"Przykładowa odpowiedź
200application/json
{
"data": [
{
"time": "2026-11-11",
"open": 757.4,
"high": 761.18,
"low": 743.92,
"close": 750.32,
"volume": 3531710
},
{
"time": "2026-11-12",
"open": 750.03,
"high": 751.29,
"low": 731.5,
"close": 733.8,
"volume": 3471317
}
],
"meta": {
"provider": "demo",
"generatedAt": "2026-11-12T21:00:04.512Z",
"disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
"symbol": "NWRB",
"range": "1M"
}
}Przykład skrócono do dwóch świec; 1M zwraca 22.
Skanowanie instrumentów
/api/screenerFiltruje, sortuje i dzieli na strony instrumenty z tymi samymi parametrami co strona skanera. Wynik zawiera rows wraz z total, page i pageSize; wartości, których nie można odczytać, są ignorowane.
Parametry
| Parametr | Gdzie | Typ | Wymagany | Opis |
|---|---|---|---|---|
| sector | query | string | Opcjonalny | Dokładna nazwa sektora: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate. |
| minMarketCap, maxMarketCap | query | number | Opcjonalny | Zakres kapitalizacji rynkowej w USD. |
| minPrice, maxPrice | query | number | Opcjonalny | Zakres ceny w USD. |
| minChangePercent, maxChangePercent | query | number | Opcjonalny | Zakres dziennej zmiany w punktach procentowych: -3 oznacza -3%. |
| minVolume | query | number | Opcjonalny | Minimalny dzienny wolumen w akcjach. |
| profitableOnly | query | string | Opcjonalny | Ustaw 1, aby zachować tylko instrumenty z EPS powyżej 0. |
| sort | query | string | Opcjonalny | Pole sortowania: marketCap (domyślnie), price, changePercent, volume lub symbol. |
| order | query | string | Opcjonalny | Kolejność sortowania: desc (domyślnie) lub asc. |
| page | query | number | Opcjonalny | Numer strony, począwszy od 1. |
| pageSize | query | number | Opcjonalny | Wierszy na stronę: domyślnie 20, maksymalnie 100. |
Zapytanie
curl -s "http://localhost:3000/api/screener?profitableOnly=1&pageSize=5"Przykładowa odpowiedź
200application/json
{
"data": {
"rows": [
{
"symbol": "NWRB",
"name": "Northwind Robotics",
"exchange": "NASDAQ",
"sector": "Technology",
"industry": "Industrial Automation",
"price": 733.8,
"change": -16.52,
"changePercent": -2.2,
"previousClose": 750.32,
"open": 750.03,
"dayHigh": 751.29,
"dayLow": 731.5,
"volume": 3471317,
"avgVolume": 2962633,
"marketCap": 982258754565,
"peRatio": 60.35,
"eps": 12.16,
"dividendYield": null,
"week52High": 963.99,
"week52Low": 583.89,
"afterHoursPrice": 731,
"afterHoursChangePercent": -0.38,
"updatedAt": "2026-11-12T21:00:00.000Z"
}
],
"total": 17,
"page": 1,
"pageSize": 5
},
"meta": {
"provider": "demo",
"generatedAt": "2026-11-12T21:00:04.512Z",
"disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
"total": 17,
"page": 1,
"pageSize": 5
}
}Przykład skrócono do jednego wiersza.
Uwierzytelnianie
Tryb demo nie wymaga klucza. Gdy serwer ustawi zmienną środowiskową API_KEY, każde zapytanie musi wysłać tę samą wartość w nagłówku X-API-Key; w przeciwnym razie otrzyma 401 unauthorized.
curl -s "http://localhost:3000/api/quotes/NWRB" \
-H "X-API-Key: your-key-here"Kody błędów
Nieudane zapytania zwracają odpowiedni status HTTP i jeden obiekt błędu. Rozgałęziaj się po code; message jest napisany dla ludzi i może się zmienić.
{
"error": {
"code": "not_found",
"message": "A human-readable explanation."
}
}| Status HTTP | Kod | Kiedy występuje |
|---|---|---|
| 400 | bad_request | Wartość parametru jest niedozwolona, na przykład nieznany zakres świec. |
| 401 | unauthorized | API_KEY jest skonfigurowany, a zapytanie nie ma pasującego nagłówka X-API-Key. |
| 404 | not_found | Taki symbol nie istnieje w zestawie danych. |
| 405 | method_not_allowed | API jest tylko do odczytu: /api/quotes odpowiada na POST tym kodem. |
| 429 | rate_limited | Więcej niż 60 zapytań w 60 sekund z jednego adresu IP do jednego punktu końcowego. Odpowiedź zawiera Retry-After w sekundach. |
Zobacz te same dane w produkcie
Przegląd rynku, strony notowań i skaner czytają dane od tego samego dostawcy co te punkty końcowe.