Getting Started

Get started with the Quartr API

Introduction

This guide introduces the Quartr API, providing access to financial event data. It aims to give you all the details needed for a straightforward integration process. The documentation spans authentication, data retrieval and webhook management, outlining the features of our RESTful API.

The API uses standard practices such as resource-oriented URLs, form-encoded request bodies, and JSON-encoded responses. It's built on standard HTTP response codes, authentication methods, and verbs, making it predictable and easy to use.

Key Sections:

  • API Key Generation and Management: Instructions on creating and managing API keys via the Quartr API Portal are provided here, granting you access to our services.

  • Authentication: This section covers how to use API keys for secure request authentication, keeping your account credentials private.

  • Usage Scenarios: We outline how best to use the API for fetching company events and data, ensuring you get up-to-date and accurate information.

  • Data Life Cycle: Learn about our Time To Live (TTL) policy, which helps ensure the data you access is current, improving the user experience.

  • Webhooks: Details on setting up webhooks for receiving real-time event updates are included, helping your applications remain updated.

Getting Started:

Start by visiting the Quartr API Portal to manage your API keys and webhooks. This portal serves as the go-to for key generation and webhook setup.

Our documentation is here to assist you in integrating financial events into your application, accessing transcripts, or handling event data efficiently. We're here to support your integration efforts with the Quartr API.


Deprecation Schedule

Basic auth - Deprecated: 1/1/2025

Authentication using Basic auth is being discontinued.

If you are currently using Basic auth, see Authentication page for how to implement it going forward.

Documents as event data fields - Deprecated: 1/6/2025

Reports, slides, slide previews, and multiple different transcript versions are currently available via url fields included with event data. For a more stable and flexible documents setup, these urls will no longer be included directly with event data, but documents will rather be available via the new Documents endpoints and webhooks.

See the Documents page for how to access documents.