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

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

API Security Features for TFE API

API Versioning

We use a date-based versioning approach:

  • APIs are versioned as /v{YYYY-MM-DD}/endpoint
  • We guarantee backward compatibility
  • At least 6 months' notice is provided before deprecating an API version

FAQ

Q: How do I report a security issue? A: Email security@tfe.ai with details of the vulnerability.

Q: Can I customize rate limits? A: Yes, enterprise clients can request custom rate limits based on their needs.

Q: What happens if my API key is compromised? A: Contact us immediately at security@tfe.ai. We will revoke the compromised key and issue a new one.

Q: Do you support mutual TLS (mTLS)? A: For banking clients requiring additional security, we offer mutual TLS authentication. Contact your account manager to set this up.

Q: What is your uptime target? A: We aim for 99.95% uptime for our production API to meet bank-level availability requirements.

Q: How do you handle data residency requirements? A: Our primary data centers are in the UK. For clients with specific residency requirements, we can discuss options for data localization.

Q: How do you handle regulatory reporting for banking clients? A: We provide comprehensive audit logs that can be exported for regulatory reporting requirements. Contact us to discuss specific reporting needs.

Q: Do you support FIDO2/WebAuthn for authentication? A: For admin interfaces, we support FIDO2/WebAuthn as a second factor. This is not available for API authentication.

Q: What encryption standards do you use for sensitive data? A: We use AES-256 for encrypting sensitive data at rest, with PBKDF2 for key derivation.

Q: How do you ensure your security keeps up with banking standards? A: We maintain regular security assessments, conduct penetration testing, and follow evolving security standards in the banking industry. Our security team monitors for emerging threats and vulnerabilities.

Security