Použij Stock Events API

Stock Events API je Pro funkce pro automatizaci dat ve tvém účtu Stock Events pomocí tvých vlastních nástrojů. Je navržena pro automatizaci účtu, nikoliv jako obecné API pro tržní data nebo vyhledávání symbolů.

Zápisy (write requests) upravují stejné watchlisty, symboly a transakce, které vidíš přímo ve Stock Events.

Co s API můžeš dělat

Seznamovat, vytvářet, získávat a aktualizovat watchlisty.
  • Seznamovat, přidávat, aktualizovat a odstraňovat symboly v watchlistu.
  • Seznamovat, vytvářet, získávat, aktualizovat a mazat transakce.
  • Číst vypočítané pohledy na Holdings a Dividends.
  • Jak si vytvořit API key

    Pro vytvoření a používání API klíčů potřebuješ aktivní předplatné Stock Events Pro.

    1. Přihlás se do webové aplikace Stock Events.
    2. Otevři svůj Profile.
    3. Vyber Settings.
    4. V sekci Account vyber Data.
    5. Vyber API Keys.
    6. Klikni na Create API key.
    7. Zadej popisné Name a pak vyber Create.
    8. Klikni na Copy API key a klíč si bezpečně ulož, než zavřeš dialogové okno.

    Celý API klíč se zobrazí pouze jednou. Jakmile okno zavřeš, obrazovka API Keys bude zobrazovat pouze jeho název, prefix, datum vytvoření a datum poslední použití místo celého klíče.

    Pokud tvé Pro předplatné vyprší, klíče zůstanou tvému účtu přiřazeny, ale API požadavky budou vracet chybu 403 Forbidden, dokud nebudeš mít Pro přístup opět aktivní.

    Proveď svůj první požadavek

    Základní URL API je https://stockevents.app/api/v1. Tvůj API klíč posílej jako bearer token v hlavičce Authorization.

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

    Tento požadavek ti vrátí tvé watchlisty a jejich ID. ID watchlistu můžeš použít u endpointů specifických pro daný watchlist, jako jsou symbol, Holdings a Dividends.

    Pro pole v požadavcích, struktury odpovědí, volitelné parametry a všechny dostupné endpointy využij tyto zdroje:

    Chraň svůj API klíč

    S API klíčem zacházej jako s heslem. Nepoužívej ho v verzovacím systému (source control), neexponuj ho v veřejném klientském kódu a neposílej ho jako parametr v dotazu nebo v těle požadavku.

    API klíče autentizují API pro automatizaci účtu bez nutnosti mít samostatná oprávnění pro každý klíč. Používej je pouze s nástroji, kterým důvěřuješ.

    Pokud dojde k úniku klíče, vrať se do API Keys, vyber Revoke API key a potvrď Revoke. Klíč přestane okamžitě fungovat a nelze jej znovu aktivovat. Pokud bude potřeba, vytvoř si nový klíč.

    Časté chyby

    • 401 Unauthorized: API klíč chybí, je neplatný nebo byl zrušen.
    • 403 Forbidden: Účet momentálně nemá aktivní Pro přístup.