Gunakan API Stock Events

Stock Events API ialah ciri Pro untuk mengautomasikan data dalam akaun Stock Events anda menggunakan alatan anda sendiri. Ia direka khas untuk automasi akaun, bukan sebagai API data pasaran umum atau carian simbol.

Permintaan "write" akan mengubah watchlist, simbol, dan transaksi yang sama seperti yang anda lihat dalam Stock Events.

Apa yang anda boleh buat dengan API ini

• Senaraikan, cipta, ambil, dan kemas kini watchlist.
• Senaraikan, tambah, kemas kini, dan buang simbol dalam watchlist.
• Senaraikan, cipta, ambil, kemas kini, dan padam transaksi.
• Baca paparan Holdings dan Dividends yang telah dikira.

Cara cipta API key

Langganan Stock Events Pro yang aktif diperlukan untuk mencipta dan menggunakan API keys.

1. Log masuk ke web app Stock Events.
2. Buka Profil anda.
3. Pilih Settings.
4. Di bawah Account, pilih Data.
5. Pilih API Keys.
6. Pilih Create API key.
7. Masukkan Nama yang sesuai, kemudian pilih Create.
8. Pilih Copy API key dan simpan key tersebut dengan selamat sebelum menutup dialog.

API key yang lengkap hanya akan dipaparkan sekali sahaja. Selepas anda menutup dialog, skrin API Keys akan menunjukkan nama, prefix, tarikh ciptaan, dan tarikh penggunaan terakhir, bukannya key yang lengkap.

Jika langganan Pro anda tidak lagi aktif, key anda akan kekal pada akaun anda, tetapi permintaan API akan memulangkan 403 Forbidden sehingga akses Pro aktif semula.

Buat permintaan pertama anda

URL asas API ialah https://stockevents.app/api/v1. Hantar API key anda sebagai bearer token dalam header Authorization.

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

Permintaan ini akan memulangkan watchlist anda dan ID mereka. Anda boleh menggunakan ID watchlist dengan endpoint simbol, Holdings, dan Dividends yang khusus untuk watchlist tersebut.

Untuk medan permintaan, struktur respons, parameter pilihan, dan semua endpoint yang tersedia, sila gunakan sumber ini:

• Dokumentasi Stock Events API
• Tetapan API Keys
• Dokumen OpenAPI

Pastikan API key anda selamat

Anggap API key seperti kata laluan anda. Jangan masukkan ia ke dalam source control, dedahkan dalam kod client awam, atau hantar dalam query parameter atau request body.

API keys mengesahkan API automasi akaun tanpa memerlukan kebenaran berasingan untuk setiap key. Gunakan ia hanya dengan alatan yang anda percayai.

Jika sesuatu key telah terdedah, kembali ke API Keys, pilih Revoke API key, kemudian sahkan Revoke. Key tersebut akan berhenti berfungsi serta-merta dan tidak boleh diaktifkan semula. Cipta key baharu jika perlu.

Ralat biasa

• 401 Unauthorized: API key hilang, tidak sah, atau telah ditarik balik (revoked).
• 403 Forbidden: Akaun anda tidak mempunyai akses Pro yang aktif buat masa ini.