Referensi API
Dokumentasi API
API JSON hanya-baca di atas data pasar yang sama dengan yang ditampilkan situs ini. Respons yang berhasil memakai amplop { data, meta }; kegagalan memakai { error: { code, message } }.
- URL dasar
- http://localhost:3000
- Metode
- Hanya GET
- Format
- JSON, UTF-8
- Batas laju
- 60 permintaan per 60 detik, per alamat IP dan endpoint
These are API examples. This site is served as static files.
MARKET_DATA_PROVIDER=fmp bersama FMP_API_KEY. Kolom meta.provider pada setiap respons menyebutkan sumber mana yang menjawab.Daftar kuotasi
/api/quotesMengembalikan satu halaman instrumen sebagai array datar, dengan total, page, dan pageSize di dalam meta. Setiap filter penyaring di bawah juga berfungsi di sini; nilai yang tidak dapat diurai akan diabaikan.
Parameter
| Parameter | Di | Tipe | Wajib | Deskripsi |
|---|---|---|---|---|
| sector | query | string | Opsional | Nama sektor persis: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate. |
| sort | query | string | Opsional | Kolom pengurutan: marketCap (bawaan), price, changePercent, volume, atau symbol. |
| order | query | string | Opsional | Arah pengurutan: desc (bawaan) atau asc. |
| page | query | number | Opsional | Nomor halaman, mulai dari 1. |
| pageSize | query | number | Opsional | Baris per halaman: 20 secara bawaan, paling banyak 100. |
Permintaan
curl -s "http://localhost:3000/api/quotes?pageSize=3"Contoh respons
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
}
}Contoh dipersingkat menjadi satu baris.
Ambil kuotasi
/api/quotes/{symbol}Mengembalikan kuotasi lengkap untuk satu instrumen atau indeks. Simbol yang tidak dikenal mengembalikan 404 not_found.
Parameter
| Parameter | Di | Tipe | Wajib | Deskripsi |
|---|---|---|---|---|
| symbol | path | string | Wajib | Simbol instrumen atau indeks, misalnya NWRB. Pencocokan mengabaikan huruf besar-kecil. |
Permintaan
curl -s "http://localhost:3000/api/quotes/NWRB"Contoh respons
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."
}
}Ambil candle
/api/candles/{symbol}Mengembalikan candle OHLCV, paling lama lebih dulu. Rentang 1D memakai interval 30-minute; setiap rentang lain memakai candle harian. Rentang yang tidak dikenal mengembalikan 400 bad_request.
Parameter
| Parameter | Di | Tipe | Wajib | Deskripsi |
|---|---|---|---|---|
| symbol | path | string | Wajib | Simbol instrumen atau indeks, misalnya NWRB. Pencocokan mengabaikan huruf besar-kecil. |
| range | query | string | Opsional | Salah satu dari 1D, 5D, 1M, 6M, 1Y, 5Y. Bawaannya 1M. |
Permintaan
curl -s "http://localhost:3000/api/candles/NWRB?range=1M"Contoh respons
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"
}
}Contoh dipersingkat menjadi dua candle; rentang 1M mengembalikan 22.
Saring instrumen
/api/screenerMenyaring, mengurutkan, dan membagi instrumen ke halaman dengan parameter yang sama seperti halaman penyaring. Hasilnya membawa rows bersama total, page, dan pageSize; nilai yang tidak dapat diurai akan diabaikan.
Parameter
| Parameter | Di | Tipe | Wajib | Deskripsi |
|---|---|---|---|---|
| sector | query | string | Opsional | Nama sektor persis: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate. |
| minMarketCap, maxMarketCap | query | number | Opsional | Batas kapitalisasi pasar dalam USD. |
| minPrice, maxPrice | query | number | Opsional | Batas harga dalam USD. |
| minChangePercent, maxChangePercent | query | number | Opsional | Batas perubahan harian dalam poin persentase: -3 berarti -3%. |
| minVolume | query | number | Opsional | Volume harian minimum dalam saham. |
| profitableOnly | query | string | Opsional | Setel ke 1 untuk hanya menyimpan instrumen dengan EPS di atas 0. |
| sort | query | string | Opsional | Kolom pengurutan: marketCap (bawaan), price, changePercent, volume, atau symbol. |
| order | query | string | Opsional | Arah pengurutan: desc (bawaan) atau asc. |
| page | query | number | Opsional | Nomor halaman, mulai dari 1. |
| pageSize | query | number | Opsional | Baris per halaman: 20 secara bawaan, paling banyak 100. |
Permintaan
curl -s "http://localhost:3000/api/screener?profitableOnly=1&pageSize=5"Contoh respons
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
}
}Contoh dipersingkat menjadi satu baris.
Autentikasi
Mode demo tidak memerlukan kunci. Saat server menyetel variabel lingkungan API_KEY, setiap permintaan harus mengirim nilai yang sama di header X-API-Key; nilai lain akan menerima 401 unauthorized.
curl -s "http://localhost:3000/api/quotes/NWRB" \
-H "X-API-Key: your-key-here"Kode kesalahan
Permintaan yang gagal mengembalikan status HTTP yang sesuai dan satu objek kesalahan. Percabangkan pada code; message ditulis untuk manusia dan dapat berubah.
{
"error": {
"code": "not_found",
"message": "A human-readable explanation."
}
}| Status HTTP | Kode | Kapan terjadi |
|---|---|---|
| 400 | bad_request | Nilai parameter tidak diizinkan, misalnya rentang candle yang tidak dikenal. |
| 401 | unauthorized | API_KEY dikonfigurasi dan permintaan tidak memiliki header X-API-Key yang cocok. |
| 404 | not_found | Simbol tidak ada dalam kumpulan data. |
| 405 | method_not_allowed | API hanya-baca: /api/quotes menjawab POST dengan kode ini. |
| 429 | rate_limited | Lebih dari 60 permintaan dalam 60 detik dari satu alamat IP ke satu endpoint. Respons menyertakan Retry-After dalam detik. |
Lihat data yang sama di dalam produk
Ringkasan pasar, halaman kuotasi, dan penyaring membaca penyedia yang sama dengan endpoint ini.