Skip to main content

SimFin

SimFin is a financial data provider that offers programmatic access to company fundamentals, financial statements, share price data, share counts, and regulatory filings through its REST API. Nexla connects to the SimFin API to ingest this data into your data flows for analysis, reporting, and downstream integration.

SimFin icon

Power end-to-end data operations for your SimFin API with Nexla. Our bi-directional SimFin connector is purpose-built for SimFin, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to SimFin or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your SimFin workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a SimFin credential, you need to obtain an API key from your SimFin account. SimFin uses API key authentication, with the key sent in the Authorization request header.

To obtain your SimFin API key, follow these steps:

  1. Sign in to your SimFin account, or register for a new account, at the SimFin Data API portal (app.simfin.com/data-api).

  2. Confirm your email address if you have not already done so. Email verification is required before the API can be accessed.

  3. Locate your API key in the Data API section of your account.

  4. Copy your API key and store it securely, as you will need it to configure your Nexla credential.

The API key is sent in the Authorization header for all API requests to the SimFin API. Keep your API key confidential, and regenerate it from your SimFin account if it is ever compromised. For more information about the SimFin API, refer to the SimFin API Documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
API KeyYesYesThe SimFin API key used to authenticate requests.

Create a credential in Nexla

  1. After selecting the data source type, click the Add Credential tile to open the Add New Credential overlay.

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

  3. Enter your SimFin API key in the API Key field. This is the key you obtained in Prerequisites, and it is sent in the Authorization header for all API requests to the SimFin API.

    Your API key grants access to your SimFin data and should be treated as sensitive information. If your key is compromised, regenerate it from your SimFin account.

    For more information about the SimFin API and available endpoints, see the SimFin API Documentation.

  4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the SimFin connector tile, then select the credential that will be used to connect to SimFin, and click Next; or, create a new SimFin credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common SimFin endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Companies

Retrieve companies.

  • This endpoint template returns the list of companies available in the SimFin database, which you can use as a reference for identifying companies in the other endpoints.

[Rest API] List Company Info

Retrieve Company Info.

  • This endpoint template returns general company information in verbose (row-based) format.

[Rest API] List Company Info Compact

Retrieve general company info in compact (columnar) format.

  • This endpoint template returns general company information in a compact, columnar layout that is more efficient for large result sets.

[Rest API] List Financial Statements

Retrieve Financial Statements.

  • This endpoint template returns company financial statements in verbose (row-based) format.

[Rest API] List Financial Statements Compact

Retrieve financial statements in compact (columnar) format.

  • This endpoint template returns company financial statements in a compact, columnar layout that is more efficient for large result sets.

[Rest API] List Price Data

Retrieve Price Data.

  • This endpoint template returns share price data in verbose (row-based) format.

[Rest API] List Price Data Compact

Retrieve share price data in compact (columnar) format.

  • This endpoint template returns share price data in a compact, columnar layout that is more efficient for large result sets.

[Rest API] List Common Shares Outstanding

Retrieve common shares outstanding.

  • This endpoint template returns the common shares outstanding reported for companies.

[Rest API] List Weighted Shares Outstanding

Retrieve weighted shares outstanding.

  • This endpoint template returns the weighted shares outstanding reported for companies.

[Rest API] List Filings By Company

Retrieve filings by company.

  • This endpoint template returns the regulatory filings associated with a company.

[Rest API] List Filings

Retrieve filings.

  • This endpoint template returns a paginated list of filings. Nexla automatically follows pagination to fetch subsequent pages of data.

[Rest API] Get Filing

Retrieve the filing document (HTML or PDF) for a given filing type and identifier.

  • Provide the Filing Type (the filing document format: html or pdf) and the Filing Identifier (the unique filing identifier obtained from the list filings endpoints) to fetch a specific filing document.

[Rest API] List Changed Companies

Retrieve companies whose data has changed since a given date.

  • This endpoint template returns the companies whose data has changed since a given date, which is useful for incremental ingestion.

[Rest API] List Database Changes

Retrieve the paginated change log of database updates.

  • This endpoint template returns the paginated change log of database updates. Nexla automatically follows pagination to fetch subsequent pages of data.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

SimFin data sources can also be manually configured to ingest data from any valid SimFin API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new SimFin data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.