Skip to main content

Authorization

Follow this guide to create a new Countercyclical credential that will allow Nexla to authenticate to and exchange data with your Countercyclical account.
countercyclical_api_auth.png

Countercyclical

Prerequisites​

Countercyclical's REST API is available to Enterprise plan customers. Before creating a Countercyclical credential in Nexla, you will need an active Countercyclical Enterprise account and an API key generated from your workspace settings.

Countercyclical Account and Plan Requirements​

  1. Ensure your organization has an active Countercyclical Enterprise subscription. API access is an Enterprise feature and is not available on standard plans.

  2. If your organization does not yet have an Enterprise subscription, contact the Countercyclical sales team at enterprise@countercyclical.io or visit countercyclical.com to request an enterprise demo and upgrade your plan.

Generate a Countercyclical API Key​

Countercyclical API keys are generated from the Settings area of your workspace. Each API key grants programmatic access to your workspace's investment research data, so it should be stored securely and treated like a password.

  1. Sign in to your Countercyclical account at dashboard.countercyclical.io.

  2. Navigate to Settings in the left-hand navigation panel.

  3. Open the Workspace settings section and select the Advanced tab.

  4. Locate the Access or API Keys section. Click the Generate API Key (or New Access Token) button to create a new key.

  5. Give your API key a descriptive name — for example, "Nexla Integration" — so it can be easily identified and managed later.

  6. Copy the generated API key immediately and store it in a secure location (such as a password manager). For security reasons, Countercyclical will not display the full key again after you navigate away from this page.

For complete information about API access and key management, refer to the Countercyclical developer documentation.

Important

Treat your Countercyclical API key like a password. Do not share it publicly or commit it to source control. If a key is compromised, revoke it immediately from your workspace settings and generate a new one.

Create a Countercyclical Credential​

  • To create a new Countercyclical credential, after selecting the data source type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key​

  1. Enter the Countercyclical API key you generated in the prerequisite steps into the API Key field. This key authenticates Nexla with the Countercyclical API and authorizes access to your workspace's investment research data.

    The API key is sent as a Bearer token in the Authorization header of all API requests made by Nexla. Ensure the key belongs to a user account that has appropriate access to the Investments, Valuations, and Memos data you intend to ingest.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source creation and can be selected for use with a new data source.