Skip to main content

API Integration Overview

The VOTR APIs split into two services. This page is a map. Each surface below has its own page with an embedded playground — pick one and try it.

How a request flows

  1. Get a token with your client credentials → Authentication.
  2. Look up events for a record date → Events.
  3. Submit shareholders for relevant events → Shareholders.
  4. (Optional) Submit daily tradesTrades.
  5. Generate a voting URL when a shareholder clicks "Vote Now" → Voting.
  6. Pass the URL into the SDKInstallation covers the React Native side.

Hosts

ConcernHost
Auth · Events · Votingapi-dev.govotr.com / api.govotr.com
Shareholders · Tradesshareholders-api-dev.govotr.com / 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.