Get summary of ISA statistics
Args: request: FastAPI request object
Returns: Summary of ISA statistics including averages, customer types, and popular metrics
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.
Access detailed analytics on Individual Savings Accounts (ISAs) including:
Comprehensive trading data analysis including:
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.
Our API offers different tiers of access:
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
}
}
The API uses standard HTTP status codes to indicate the success or failure of requests:
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"
}
The API uses a semantic versioning system (Major.Minor.Patch). The current version is 2.1.3.
This section provides key statistical metrics and summary data for ISA investments, including averages, popular choices, and growth metrics.
GET /isa/summary
- Get comprehensive summary of ISA statisticsGET /isa/trends/{period}
- Get trend analysis for specified periodGET /isa/isa-type
- Get breakdown of ISA data by calculator typeGET /isa/horizontal-insight/{age_group}/{current_provider}/{new_provider}/{interest_rate}/{years}/{annual_income}/{calculator_type}
- Get horizontal insights with specified parametersGET /isa/average-final-amount
- Get average final amount for ISAsGET /isa/average-final-amount/{start_date}
- Get average final amount for a specific date rangeGET /isa/average-growth-amount
- Get average growth amount for ISAsGET /isa/average-growth-amount/{start_date}
- Get average growth amount for a specific date rangeGET /isa/average-deposit-transfer
- Get average deposit amount for transfersGET /isa/average-deposit-transfer/{start_date}
- Get average deposit amount for transfers in a specific date rangeGET /isa/average-final-amount-transfer
- Get average final amount for transfersGET /isa/average-final-amount-transfer/{start_date}
- Get average final amount for transfers in a specific date rangeGET /isa/average-years
- Get average term in yearsGET /isa/average-years/{start_date}
- Get average term in years for a specific date rangeGET /isa/average-interest-rate
- Get average interest rateGET /isa/average-interest-rate/{start_date}
- Get average interest rate for a specific date rangecurl -i -X GET \
https://docs.tfe.ai/_mock/openapi/ISA/summary \
-H 'X-API-Key: YOUR_API_KEY_HERE'