API Documentation (2.1.3)

Financial Analytics API

Overview

The Financial Analytics API provides comprehensive data analysis and insights for ISA investments and trading behavior. This powerful platform enables financial institutions, advisors, and analysts to access detailed metrics, trends, and recommendations through a simple, consistent REST API.

Key Capabilities

ISA Analytics

Access detailed analytics on Individual Savings Accounts (ISAs) including:

  • Provider market share and performance metrics
  • Customer demographic analysis across age groups and income brackets
  • Behavioral patterns and investment preferences
  • Term duration and risk profile analysis
  • Personalized provider recommendations

Trading Analytics

Comprehensive trading data analysis including:

  • Market trends and sentiment indicators
  • Trading pair popularity and directional bias
  • Trader behavior patterns and preferences
  • Broker performance metrics and comparison
  • Predictive signals and anomaly detection

Authentication

All API requests require authentication using an API key which should be passed as a query parameter:

GET /isa/summary?api_key=your_api_key

Contact our team to obtain your API key and access credentials.

Rate Limits

Our API offers different tiers of access:

  • Standard: 60 requests per minute
  • Premium: 300 requests per minute
  • Enterprise: Custom limits available

Response Format

All responses are returned in JSON format and follow a consistent structure:

{
  "timestamp": "2024-03-20T12:00:00Z",
  "data": {
    // Response data specific to the endpoint
  }
}

Error Handling

The API uses standard HTTP status codes to indicate the success or failure of requests:

  • 200: Success
  • 400: Bad request (invalid parameters)
  • 401: Unauthorized (invalid API key)
  • 404: Resource not found
  • 422: Validation error
  • 429: Rate limit exceeded
  • 500: Server error

Error responses include detailed information to help troubleshoot the issue:

{
  "timestamp": "2024-03-20T12:00:00Z",
  "error": "Validation Error",
  "detail": "Invalid parameter: start_date must be in DD-MM-YY format"
}

Versioning

The API uses a semantic versioning system (Major.Minor.Patch). The current version is 2.1.3.

Getting Started

  1. Sign up for an API key at our developer portal
  2. Explore the available endpoints in this documentation
  3. Make your first request to the API
  4. Implement the insights into your application or analysis
Download OpenAPI description
Languages
Servers
Mock server
https://docs.tfe.ai/_mock/openapi/
Production server
https://api.tfe.ai/

Behavioral

Operations

Demographic

Operations

Provider

Operations

Summary

Operations

ISA Analytics - Summary Metrics

This section provides key statistical metrics and summary data for ISA investments, including averages, popular choices, and growth metrics.

Endpoints

General Summary

  • GET /isa/summary - Get comprehensive summary of ISA statistics
  • GET /isa/trends/{period} - Get trend analysis for specified period
  • GET /isa/isa-type - Get breakdown of ISA data by calculator type
  • GET /isa/horizontal-insight/{age_group}/{current_provider}/{new_provider}/{interest_rate}/{years}/{annual_income}/{calculator_type} - Get horizontal insights with specified parameters

Average Value Metrics

  • GET /isa/average-final-amount - Get average final amount for ISAs
  • GET /isa/average-final-amount/{start_date} - Get average final amount for a specific date range
  • GET /isa/average-growth-amount - Get average growth amount for ISAs
  • GET /isa/average-growth-amount/{start_date} - Get average growth amount for a specific date range
  • GET /isa/average-deposit-transfer - Get average deposit amount for transfers
  • GET /isa/average-deposit-transfer/{start_date} - Get average deposit amount for transfers in a specific date range
  • GET /isa/average-final-amount-transfer - Get average final amount for transfers
  • GET /isa/average-final-amount-transfer/{start_date} - Get average final amount for transfers in a specific date range
  • GET /isa/average-years - Get average term in years
  • GET /isa/average-years/{start_date} - Get average term in years for a specific date range
  • GET /isa/average-interest-rate - Get average interest rate
  • GET /isa/average-interest-rate/{start_date} - Get average interest rate for a specific date range

Isa Summary Endpoint

Request

Get summary of ISA statistics

Args: request: FastAPI request object

Returns: Summary of ISA statistics including averages, customer types, and popular metrics

curl -i -X GET \
  https://docs.tfe.ai/_mock/openapi/ISA/summary \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Market Analysis

Analysis of market trends, instruments, and trading signals

Operations

Trader Analytics

Analysis of trader behavior and demographics

Operations

Broker Insights

Broker analysis, comparison, and performance metrics

Operations

Summary Metrics

Overview statistics and most popular metrics

Operations

FAQ

Error Handling

Quick Start Guide

Authentication

Security