Generate an API key

Generates an API key on your profile page. You will need this key to generate an OAuth token to submit requests.

📘

Before you begin

You require an Index UI account username and password to establish authentication. If you do not have an Index UI account, contact your Index Representative.

📘

Note:

API keys can only be generated once per hour.

  1. Navigate to https://app.indexexchange.com in a browser.
  2. Enter your email address and password.
  3. Click Sign In.
  4. If you have more than one account, select the account for which you want to generate an API key.
  5. In the top-right corner, click your account name and select API Access.
  6. If this is the first time that you are generating an API key, click on the Generate API Key button, otherwise click on Regenerate API Key. If you regenerate your API key, any services using the the old key will need to be updated to use the new key.
  7. Copy your API key and store it in a secure location.