Overview

Generate a Token

The Equity Analytics API requires the use of a Bearer token for authentication. This page explains how to generate a token and use it.

1. Log into Equity Analytics
2. In the navbar, click the dropdown button with your name
3. Click Profile
4. In the sidebar, click API
5. Click the Create an API Token button
6. Name the token and click the button to create it
7. Click the Reveal button to see the token
8. Copy it

If you lose your token, don't worry about it. You can always come back to see it again.

Access the API

Every API endpoint for Equity Analytics requires your API token for access. To use the token, pass an Authorization header with the token in it.

For example, to access the api/v1/me endpoint (replace TOKEN with the value of the token you copied from the Generate a Token section):

curl https://equityanalyticsms.com/api/v1/me \
  -H "Accept: application/json" \
  -H "Authorization: Bearer TOKEN"

API Reference

The full API Reference, with examples and endpoint documentation, is available at https://equityanalyticsms.com/api-docs.