Skip to main content

API Integration Overview

The VOTR API is how your backend talks to VOTR — authenticate, look up voting events, submit shareholder and trade records, and generate the ballot URLs your shareholders use. It spans two services (Integration and Shareholders), and every operation below has its own page with an embedded playground you can try.

How a request flows​

  1. Get a token

    Exchange your client credentials for an access token → Authentication.

  2. Look up events

    List events for a given record date → Events.

  3. Submit shareholders

    For every relevant event, post the holder list → Shareholders.

  4. Submit daily trades

    Optional — keep the holder list current between record date and meeting → Trades.

  5. Generate a voting URL

    Issue a short-lived ballot URL when a shareholder taps "Vote Now" → Voting. Open it in your app however you like.

Hosts​

Auth · Events · Voting

  • Developmenthttps://api-dev.govotr.com
  • Productionhttps://api.govotr.com

Shareholders · Trades

  • Developmenthttps://shareholders-api-dev.govotr.com
  • Productionhttps://shareholders-api.govotr.com

Each operation in the embedded playgrounds pins its own server — pick Development or Production in the playground's server dropdown before firing a call.

Security model​

The frontend should never hold your client_id / client_secret. Your backend exchanges them for an access token, then your backend (not the browser) calls VOTR. See Prerequisites → Security model for the full pattern.