Stock Events

Stock Events

Sử dụng Stock Events API nhé

Stock Events API là một tính năng dành cho gói Pro, giúp bạn tự động hóa dữ liệu trong tài khoản Stock Events từ các công cụ riêng của mình. API này được thiết kế để tự động hóa tài khoản, chứ không phải là một API cung cấp dữ liệu thị trường chung hay tìm kiếm mã chứng khoán.

Các yêu cầu ghi (write requests) sẽ chỉnh sửa trực tiếp các danh sách theo dõi (watchlists), mã chứng khoán (symbols) và các giao dịch (transactions) mà bạn thấy trong Stock Events.

Bạn có thể làm gì với API này

Liệt kê, tạo, lấy thông tin và cập nhật các danh sách theo dõi (watchlists).
  • Liệt kê, thêm, cập nhật và xóa các mã chứng khoán (symbols) trong một danh sách theo dõi.
  • Liệt kê, tạo, lấy thông tin, cập nhật và xóa các giao dịch (transactions).
  • Đọc các chế độ xem Holdings (tổng tài sản) và Dividends (cổ tức) đã được tính toán.

    • Cách tạo API key

    Bạn cần có gói đăng ký Stock Events Pro đang hoạt động để tạo và sử dụng API keys.

    1. Đăng nhập vào ứng dụng web Stock Events.
    2. Mở phần Profile của bạn.
    3. Chọn Settings.
    4. Trong mục , chọn Data.
    5. Chọn API Keys.
    6. Chọn Create API key.
    7. Nhập Name mô tả, sau đó chọn Create.
    8. Chọn Copy API key và lưu trữ key này một cách an toàn trước khi đóng hộp thoại.

    Mã API key đầy đủ chỉ hiển thị duy nhất một lần. Sau khi bạn đóng hộp thoại, màn hình API Keys sẽ chỉ hiển thị tên, tiền tố (prefix), ngày tạo và ngày sử dụng cuối cùng thay vì toàn bộ mã key.

    Nếu gói đăng ký Pro của bạn hết hạn, các key vẫn gắn liền với tài khoản của bạn, nhưng các yêu cầu API sẽ trả về lỗi 403 Forbidden cho đến khi quyền truy cập Pro được kích hoạt trở lại.

    Thực hiện yêu cầu đầu tiên

    URL cơ sở của API là https://stockevents.app/api/v1. Hãy gửi API key của bạn dưới dạng một bearer token trong header Authorization.

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

    Yêu cầu này sẽ trả về các danh sách theo dõi của bạn và ID của chúng. Bạn có thể sử dụng ID của watchlist với các endpoint dành riêng cho symbol, Holdings và Dividends của watchlist đó.

    Để biết thêm về các trường trong yêu cầu, cấu trúc phản hồi, các tham số tùy chọn và tất cả các endpoint hiện có, hãy tham khảo các tài nguyên sau:

    Giữ an toàn cho API key của bạn

    Hãy coi API key như một mật khẩu. Đừng đưa nó vào mã nguồn (source control), đừng để lộ nó trong mã client công khai, hoặc gửi nó trong tham số truy vấn (query parameter) hay thân yêu cầu (request body).

    API keys dùng để xác thực API tự động hóa tài khoản mà không cần các quyền riêng biệt cho từng key. Chỉ nên sử dụng chúng với các công cụ mà bạn tin tưởng.

    Nếu một key bị lộ, hãy quay lại mục API Keys, chọn Revoke API key, sau đó xác nhận Revoke. Key đó sẽ ngừng hoạt động ngay lập tức và không thể kích hoạt lại. Hãy tạo một key thay thế nếu cần thiết.

    Các lỗi thường gặp

    • 401 Unauthorized: API key bị thiếu, không hợp lệ hoặc đã bị thu hồi.
    • 403 Forbidden: Tài khoản hiện tại không có quyền truy cập Pro.