Provider
/
Bank Breakdown

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
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.tfe.ai/_mock/openapi/
Production server
https://api.tfe.ai/

Behavioral

Operations

Demographic

Operations

Provider

Operations

ISA Analytics: Provider Module

This module provides analysis and comparison of ISA providers, enabling detailed evaluation of market share, performance metrics, and customer preferences across different providers.

Endpoints

The Provider module includes the following endpoints:

GET /isa/bank-breakdown
GET /isa/bank-breakdown/{start_date}/{end_date}
GET /isa/term-breakdown
GET /isa/term-breakdown/{start_date}/{end_date}
GET /isa/inflow-breakdown
GET /isa/inflow-breakdown/{start_date}/{end_date}
GET /isa/risk-breakdown
GET /isa/risk-breakdown/{start_date}/{end_date}
GET /isa/recommendations/{provider}

Provider Analysis

The Provider module offers comprehensive insights into ISA providers:

  • Market share and provider adoption rates
  • Provider metrics and performance comparison
  • Term duration distribution by provider
  • Inflow and transfer patterns between providers
  • Risk profile distribution across providers
  • Provider recommendations and personalized insights

Key Features

Bank Breakdown

Request

Get bank breakdown with metrics by provider

Args: request: FastAPI request object provider: Optional provider name to filter by start_date: Optional start date in DD-MM-YY format end_date: Optional end date in DD-MM-YY format

Returns: Bank breakdown information including provider statistics

Query
providerProvider (string) or Provider (null)(Provider)
Any of:
string(Provider)
start_dateStart Date (string) or Start Date (null)(Start Date)
Any of:
string(Start Date)
end_dateEnd Date (string) or End Date (null)(End Date)
Any of:
string(End Date)
curl -i -X GET \
  'https://docs.tfe.ai/_mock/openapi/ISA/bank-breakdown?end_date=string&provider=string&start_date=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
statusstring
Example: "success"
messagestring
Example: "Bank breakdown retrieved successfully"
timestampstring(date-time)
total_providersinteger
Example: 15
provider_statisticsArray of objects
date_rangestring
Example: "25-02-24 to 25-03-24"
Response
application/json
{
  "status": "success",
  "message": "Bank breakdown retrieved successfully",
  "timestamp": "2019-08-24T14:15:22Z",
  "total_providers": 15,
  "provider_statistics": [
    { … }
  ],
  "date_range": "25-02-24 to 25-03-24"
}

Term Breakdown

Request

Get breakdown analysis by term length (years)

Args: request: FastAPI request object provider: Filter by provider start_date: Optional start date in DD-MM-YY format end_date: Optional end date in DD-MM-YY format

Returns: ISA statistics broken down by term length categories

Query
providerstring(Provider)

Filter by provider

start_dateStart Date (string) or Start Date (null)(Start Date)
Any of:
string(Start Date)
end_dateEnd Date (string) or End Date (null)(End Date)
Any of:
string(End Date)
curl -i -X GET \
  'https://docs.tfe.ai/_mock/openapi/ISA/term-breakdown?end_date=string&provider=string&start_date=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
dataArray of objects
statusstring
Example: "success"
timestampstring(date-time)
date_rangestring
Example: "25-02-24 to 25-03-24"
providerstring
Example: "All Providers"
breakdown_typestring
Example: "Term"
Response
application/json
{
  "status": "success",
  "message": "Term breakdown retrieved successfully",
  "timestamp": "2023-06-01T12:00:00Z",
  "data": {
    "date_range": "01-01-24 to 01-02-24",
    "term_categories": [ … ]
  }
}

Summary

Operations

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