ใช้งาน Stock Events API กันเลย

Stock Events API เป็นฟีเจอร์สำหรับสมาชิก Pro เพื่อช่วยให้คุณจัดการข้อมูลในบัญชี Stock Events ของคุณผ่านเครื่องมือส่วนตัวได้แบบอัตโนมัติ โดยตัวนี้ถูกออกแบบมาเพื่อการทำ Account Automation โดยเฉพาะ ไม่ใช่ API สำหรับดึงข้อมูลตลาดทั่วไปหรือใช้ค้นหาสัญลักษณ์หุ้น (symbol-search) นะครับ

การส่งคำสั่งแบบ Write requests จะเข้าไปแก้ไข watchlist, symbols และ transactions ชุดเดียวกับที่คุณเห็นใน Stock Events เลย

สิ่งที่คุณทำได้ด้วย API

  • เรียกดู, สร้าง, ดึงข้อมูล และอัปเดต watchlist
  • เรียกดู, เพิ่ม, อัปเดต และลบ symbols ใน watchlist
  • เรียกดู, สร้าง, ดึงข้อมูล, อัปเดต และลบ transactions
  • อ่านข้อมูลการคำนวณในส่วนของ Holdings และ Dividends

วิธีสร้าง API key

คุณต้องมีสมาชิก Stock Events Pro ที่ยังใช้งานได้อยู่ถึงจะสร้างและใช้งาน API keys ได้ครับ

  1. ล็อกอินเข้าสู่ Stock Events web app
  2. ไปที่ Profile ของคุณ
  3. เลือก Settings
  4. ภายใต้หัวข้อ Account ให้เลือก Data
  5. เลือก API Keys
  6. เลือก Create API key
  7. ตั้ง Name เพื่อให้จำง่าย แล้วกด Create
  8. เลือก Copy API key และเก็บคีย์ไว้ในที่ปลอดภัยก่อนจะปิดหน้าต่างนี้ไป

API key แบบเต็มจะแสดงให้เห็นแค่ครั้งเดียวเท่านั้น หลังจากปิดหน้าต่างไปแล้ว ในหน้า API Keys จะแสดงแค่ชื่อ, prefix, วันที่สร้าง และวันที่ใช้งานล่าสุด แทนที่จะเป็นคีย์ตัวเต็มครับ

หากสมาชิก Pro ของคุณหมดอายุ คีย์ต่างๆ จะยังคงผูกอยู่กับบัญชีของคุณ แต่การส่ง API requests จะได้รับข้อความ 403 Forbidden จนกว่าคุณจะกลับมาเป็นสมาชิก Pro อีกครั้ง

ลองส่ง request แรกของคุณ

Base URL ของ API คือ https://stockevents.app/api/v1 โดยให้ส่ง API key ของคุณในรูปแบบ bearer token ใน header Authorization ครับ

curl -H "Authorization: Bearer $STOCK_EVENTS_API_KEY" \ 
  https://stockevents.app/api/v1/watchlists

Request นี้จะส่งข้อมูล watchlist และ ID ของแต่ละอันกลับมาให้คุณ ซึ่งคุณสามารถเอา watchlist ID ไปใช้กับ endpoint ของ symbol, Holdings และ Dividends ที่เจาะจงเฉพาะ watchlist นั้นๆ ได้เลย

สำหรับรายละเอียดเรื่อง field ใน request, โครงสร้าง response, parameter เสริม และ endpoint ทั้งหมดที่มี สามารถดูได้จากแหล่งข้อมูลเหล่านี้ครับ:

รักษา API key ของคุณให้ปลอดภัย

ให้ดูแล API key เหมือนกับรหัสผ่านเลยนะครับ อย่าเอาไปใส่ไว้ใน source control, อย่าเปิดเผยใน client code ที่เป็นสาธารณะ หรือส่งไปใน query parameter หรือ request body นะครับ

API keys ใช้เพื่อยืนยันตัวตนสำหรับการทำ account automation API โดยไม่ต้องแยก permission สำหรับแต่ละคีย์ ดังนั้นควรใช้กับเครื่องมือที่คุณไว้ใจเท่านั้นครับ

ถ้าเกิดคีย์หลุดหรือถูกเปิดเผย ให้กลับไปที่ API Keys เลือก Revoke API key แล้วกดยืนยัน Revoke คีย์นั้นจะใช้งานไม่ได้ทันทีและไม่สามารถเปิดใช้งานใหม่ได้ หากจำเป็นต้องใช้ต่อ ให้สร้างคีย์ใหม่ขึ้นมาแทนนะครับ

ข้อผิดพลาดที่พบบ่อย

  • 401 Unauthorized: ไม่พบ API key, คีย์ไม่ถูกต้อง หรือคีย์ถูกยกเลิกไปแล้ว
  • 403 Forbidden: บัญชีของคุณไม่ได้มีสถานะสมาชิก Pro ในขณะนี้