Skip to main content

Authorization

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

Finnworlds

Prerequisites​

To connect Nexla to the Finnworlds API, you need a Finnworlds account and an active API key. Finnworlds uses API key authentication — the key is passed as a query parameter with every request.

Obtain a Finnworlds API Key​

Finnworlds provides an API key immediately upon account registration. The key is auto-generated and ready to use with no additional authorization steps required.

  1. Visit finnworlds.com and click Sign Up (or Log In if you already have an account).

  2. Complete the registration form with your name, email address, and a password, then confirm your email address if prompted.

  3. Once logged in, navigate to your Account Dashboard or API Keys section to locate your API key. Finnworlds generates the key automatically — it is displayed on the dashboard and is ready to use immediately.

  4. Copy the API key and store it securely. This key authenticates all API requests and should be treated like a password.

Finnworlds offers several subscription tiers, including a free plan that provides access to basic API endpoints for exploration and development. Paid plans (Individual, Starter, Developers, and Enterprise) unlock higher request limits and additional endpoints. For academic or non-profit use, contact Finnworlds at support@finnworlds.com to discuss discounted access. Additional plan details are available at finnworlds.com/pricing.

Important

Keep your Finnworlds API key confidential. Avoid embedding the key in public repositories or client-side code. If a key is compromised, regenerate it from your Finnworlds account dashboard.

Create a Finnworlds Credential​

  • To create a new Finnworlds 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 your Finnworlds API key in the API Key field. This key authenticates Nexla with the Finnworlds API. Nexla will include the key as a key query parameter in all API requests to Finnworlds endpoints (for example: https://api.finnworlds.com/api/v1/benchmark?key=YOUR_API_KEY).

    The API key can be found in your Finnworlds account dashboard. For complete information about managing your API key, visit the Finnworlds documentation.

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.