APIs Overview

This page provides an overview of the APIs available for Accelerators. It helps you identify the appropriate API for your use case before navigating to the detailed parameter and configuration documentation.

The APIs fall into two main categories:

• FSI data access and aggregation APIs
• Order execution analytics APIs

FSI data access and aggregation APIs

These APIs are typically executed on a Data Access Process (DAP) and operate within the .fsi namespace:

• getTicks API - Retrieves raw data from configured database tables with optional preprocessing and enrichment.
• getStats API - Performs aggregations and windowed calculations on data retrieved using getTicks.
• getBars API - Retrieves pre-aggregated and persisted bar data.

Order execution analytics APIs

These APIs support generation and retrieval of Order Analytics data:

• generateOrderAnalytics API - Generates analytics records from the Order table and associated workflows.
• getOrderAnalyticSummary API - Retrieves Order Analytics data and computes summary roll-ups.

Related documentation

The following pages provide supporting configuration and customization details:

• Customize getStats – Extend or define additional analytics for use with getStats.
• Customize Data for Use With getBars – Configure data persistence for getBars.
• API Configuration – Configuration options required for API functionality.
• API Errors Glossary – Reference for API error messages.

Choosing the right API

• Use getTicks for detailed, record-level data access.
• Use getStats for aggregations and time-windowed analytics.
• Use getBars for fast retrieval of persisted bar data.
• Use generateOrderAnalytics and getOrderAnalyticSummary for Order Execution Analytics workflows and reporting.