ข้อมูลอ้างอิง API
เอกสาร API
API แบบ JSON ที่อ่านอย่างเดียวบนข้อมูลตลาดชุดเดียวกับที่เว็บไซต์นี้แสดง การตอบกลับที่สำเร็จใช้โครง { data, meta } ส่วนกรณีล้มเหลวใช้ { error: { code, message } }
- URL หลัก
- http://localhost:3000
- เมธอด
- GET เท่านั้น
- รูปแบบ
- JSON, UTF-8
- ขีดจำกัดอัตรา
- 60 คำขอต่อ 60 วินาที ต่อหนึ่งที่อยู่ IP และหนึ่งปลายทาง
These are API examples. This site is served as static files.
MARKET_DATA_PROVIDER=fmp พร้อมกับ FMP_API_KEY ฟิลด์ meta.provider ในทุกการตอบกลับจะบอกว่าต้นทางใดเป็นผู้ตอบแสดงรายการราคา
/api/quotesคืนหน้าหนึ่งของตราสารเป็นอาร์เรย์แบน พร้อม total, page และ pageSize ใน meta ตัวกรองการคัดกรองทั้งหมดด้านล่างใช้ได้ที่นี่ด้วย ค่าที่แยกวิเคราะห์ไม่ได้จะถูกละเว้น
พารามิเตอร์
| พารามิเตอร์ | ตำแหน่ง | ชนิด | จำเป็น | คำอธิบาย |
|---|---|---|---|---|
| sector | query | string | ไม่บังคับ | ชื่อกลุ่มอุตสาหกรรมแบบตรงตัว: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate |
| sort | query | string | ไม่บังคับ | ฟิลด์ที่ใช้เรียง: marketCap (ค่าเริ่มต้น), price, changePercent, volume หรือ symbol |
| order | query | string | ไม่บังคับ | ทิศทางการเรียง: desc (ค่าเริ่มต้น) หรือ asc |
| page | query | number | ไม่บังคับ | หมายเลขหน้า เริ่มที่ 1 |
| pageSize | query | number | ไม่บังคับ | จำนวนแถวต่อหน้า: 20 ตามค่าเริ่มต้น และสูงสุด 100 |
คำขอ
curl -s "http://localhost:3000/api/quotes?pageSize=3"ตัวอย่างการตอบกลับ
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
}
}ตัวอย่างถูกย่อเหลือหนึ่งแถว
ดึงราคาหนึ่งรายการ
/api/quotes/{symbol}คืนราคาเต็มของตราสารหรือดัชนีหนึ่งรายการ สัญลักษณ์ที่ไม่รู้จักจะคืน 404 not_found
พารามิเตอร์
| พารามิเตอร์ | ตำแหน่ง | ชนิด | จำเป็น | คำอธิบาย |
|---|---|---|---|---|
| symbol | path | string | จำเป็น | สัญลักษณ์ของตราสารหรือดัชนี เช่น NWRB การจับคู่ไม่สนใจตัวพิมพ์เล็กใหญ่ |
คำขอ
curl -s "http://localhost:3000/api/quotes/NWRB"ตัวอย่างการตอบกลับ
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."
}
}ดึงแท่งเทียน
/api/candles/{symbol}คืนแท่งเทียน OHLCV จากเก่าไปใหม่ ช่วง 1D ใช้ช่วงเวลา 30-minute ส่วนช่วงอื่นทั้งหมดใช้แท่งเทียนรายวัน ช่วงที่ไม่รู้จักจะคืน 400 bad_request
พารามิเตอร์
| พารามิเตอร์ | ตำแหน่ง | ชนิด | จำเป็น | คำอธิบาย |
|---|---|---|---|---|
| symbol | path | string | จำเป็น | สัญลักษณ์ของตราสารหรือดัชนี เช่น NWRB การจับคู่ไม่สนใจตัวพิมพ์เล็กใหญ่ |
| range | query | string | ไม่บังคับ | หนึ่งใน 1D, 5D, 1M, 6M, 1Y, 5Y ค่าเริ่มต้นคือ 1M |
คำขอ
curl -s "http://localhost:3000/api/candles/NWRB?range=1M"ตัวอย่างการตอบกลับ
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"
}
}ตัวอย่างถูกย่อเหลือสองแท่งเทียน ส่วนช่วง 1M คืน 22 แท่ง
คัดกรองตราสาร
/api/screenerกรอง เรียงลำดับ และแบ่งหน้าตราสารด้วยพารามิเตอร์ชุดเดียวกับหน้าคัดกรอง ผลลัพธ์มี rows พร้อมกับ total, page และ pageSize ค่าที่แยกวิเคราะห์ไม่ได้จะถูกละเว้น
พารามิเตอร์
| พารามิเตอร์ | ตำแหน่ง | ชนิด | จำเป็น | คำอธิบาย |
|---|---|---|---|---|
| sector | query | string | ไม่บังคับ | ชื่อกลุ่มอุตสาหกรรมแบบตรงตัว: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate |
| minMarketCap, maxMarketCap | query | number | ไม่บังคับ | ขอบเขตมูลค่าตลาดในหน่วย USD |
| minPrice, maxPrice | query | number | ไม่บังคับ | ขอบเขตราคาในหน่วย USD |
| minChangePercent, maxChangePercent | query | number | ไม่บังคับ | ขอบเขตการเปลี่ยนแปลงรายวันเป็นจุดเปอร์เซ็นต์: -3 หมายถึง -3% |
| minVolume | query | number | ไม่บังคับ | ปริมาณซื้อขายรายวันขั้นต่ำเป็นจำนวนหุ้น |
| profitableOnly | query | string | ไม่บังคับ | ตั้งเป็น 1 เพื่อเก็บเฉพาะตราสารที่มี EPS สูงกว่า 0 |
| sort | query | string | ไม่บังคับ | ฟิลด์ที่ใช้เรียง: marketCap (ค่าเริ่มต้น), price, changePercent, volume หรือ symbol |
| order | query | string | ไม่บังคับ | ทิศทางการเรียง: desc (ค่าเริ่มต้น) หรือ asc |
| page | query | number | ไม่บังคับ | หมายเลขหน้า เริ่มที่ 1 |
| pageSize | query | number | ไม่บังคับ | จำนวนแถวต่อหน้า: 20 ตามค่าเริ่มต้น และสูงสุด 100 |
คำขอ
curl -s "http://localhost:3000/api/screener?profitableOnly=1&pageSize=5"ตัวอย่างการตอบกลับ
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
}
}ตัวอย่างถูกย่อเหลือหนึ่งแถว
การยืนยันตัวตน
โหมดเดโมไม่ต้องใช้คีย์ เมื่อเซิร์ฟเวอร์ตั้งค่าตัวแปรสภาพแวดล้อม API_KEY ทุกคำขอต้องส่งค่าเดียวกันในเฮดเดอร์ X-API-Key ค่าอื่นใดจะได้รับ 401 unauthorized
curl -s "http://localhost:3000/api/quotes/NWRB" \
-H "X-API-Key: your-key-here"รหัสข้อผิดพลาด
คำขอที่ล้มเหลวจะคืนสถานะ HTTP ที่สอดคล้องและออบเจกต์ข้อผิดพลาดหนึ่งรายการ ให้แยกตาม code ส่วน message เขียนขึ้นสำหรับมนุษย์และอาจเปลี่ยนได้
{
"error": {
"code": "not_found",
"message": "A human-readable explanation."
}
}| สถานะ HTTP | รหัส | เกิดขึ้นเมื่อใด |
|---|---|---|
| 400 | bad_request | ค่าพารามิเตอร์ไม่อยู่ในเกณฑ์ที่อนุญาต เช่น ช่วงแท่งเทียนที่ไม่รู้จัก |
| 401 | unauthorized | ตั้งค่า API_KEY ไว้แล้วและคำขอไม่มีเฮดเดอร์ X-API-Key ที่ตรงกัน |
| 404 | not_found | ไม่มีสัญลักษณ์นี้อยู่ในชุดข้อมูล |
| 405 | method_not_allowed | API เป็นแบบอ่านอย่างเดียว: /api/quotes ตอบ POST ด้วยรหัสนี้ |
| 429 | rate_limited | มีคำขอเกิน 60 คำขอใน 60 วินาทีจากที่อยู่ IP หนึ่งไปยังปลายทางหนึ่ง การตอบกลับมี Retry-After เป็นวินาที |
ดูข้อมูลชุดเดียวกันในผลิตภัณฑ์
ภาพรวมตลาด หน้าราคา และหน้าคัดกรองอ่านผู้ให้บริการชุดเดียวกับปลายทางเหล่านี้