Risk 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

Sign up for an API key at our developer portal
Explore the available endpoints in this documentation
Make your first request to the API
Implement the insights into your application or analysis

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Mock server

https://docs.tfe.ai/_mock/openapi/

Production server

https://api.tfe.ai/

Behavioral

Operations

Demographic

Operations

Provider

Operations

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": [ … ]
  }
}

Risk Breakdown

Request

Get breakdown analysis by risk score

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 risk profile

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/risk-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": "Risk breakdown retrieved successfully",
  "timestamp": "2023-06-01T12:00:00Z",
  "data": {
    "date_range": "01-01-24 to 01-02-24",
    "risk_categories": [ … ]
  }
}

Inflow Breakdown

Request

Get breakdown analysis of ISA inflow patterns showing provider transitions from current_provider to new_provider with associated metrics.

Args: request: FastAPI request object provider: Filter by provider (looks in both current_provider and new_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 provider transitions

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/inflow-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": "Inflow breakdown retrieved successfully",
  "timestamp": "2023-06-01T12:00:00Z",
  "data": {
    "date_range": "01-01-24 to 01-02-24",
    "provider": "all",
    "provider_transitions": [ … ]
  }
}

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

API Documentation (2.1.3)

Financial Analytics API

Overview

Key Capabilities

ISA Analytics

Trading Analytics

Authentication

Rate Limits

Response Format

Error Handling

Versioning

Getting Started

Behavioral

Demographic

Provider

Term Breakdown

Request

Responses

Was this helpful?

Risk Breakdown

Request

Responses

Was this helpful?

Inflow Breakdown

Request

Responses

Was this helpful?

Summary

Market Analysis

Trader Analytics

Broker Insights

Summary Metrics

FAQ

Error Handling

Quick Start Guide

Authentication

Security

API Documentation (2.1.3)

Financial Analytics API

Overview

Key Capabilities

ISA Analytics

Trading Analytics

Authentication

Rate Limits

Response Format

Error Handling

Versioning

Getting Started

Behavioral

Demographic

Provider

Term Breakdown

RequestExpand all

Responses

Was this helpful?

Risk Breakdown

RequestExpand all

Responses

Was this helpful?

Inflow Breakdown

RequestExpand all

Responses

Was this helpful?

Summary

Market Analysis

Trader Analytics

Broker Insights

Summary Metrics

FAQ

Error Handling

Quick Start Guide

Authentication

Security

Request

Request

Request