API Reference

Last updated: March 2026

Overview

Base URLhttps://api.fxengineer.com
AuthBearer token via POST /auth/login
FormatJSON

Most endpoints accept optional authentication. Performance and history endpoints are public. Active patterns and approaching patterns require an active subscription.

Authorization: Bearer <jwt_token>

Patterns

GET/patterns/activeSubscription

Currently active patterns awaiting resolution.

ParamTypeDescription
symbolstringFilter by symbol (e.g. EURUSD)
strategystringSWIFT, PULSE, or ANCHOR
GET/patterns/approachingSubscription

Patterns nearing trigger conditions.

GET/patterns/history

Historical pattern occurrences with outcome data.

ParamTypeDescription
symbolstringFilter by symbol
strategystringSWIFT, PULSE, or ANCHOR
convictionstringHIGH or STANDARD
resultstringFAVORABLE or UNFAVORABLE
limitintPage size (default 50, max 500)
offsetintPagination offset

Performance

GET/performance/summary

Aggregate strategy performance.

GET/performance/by-year

Year-by-year breakdown.

ParamTypeDescription
strategystringFilter by strategy
GET/performance/by-symbol

Per-pattern performance.

ParamTypeDescription
tierstringULTRA, PREMIUM, or STANDARD
GET/performance/symbol/{symbol}

Single symbol detail with per-strategy breakdown.

Symbols

GET/symbols

All pattern configurations.

ParamTypeDescription
statusstringACTIVE, VALIDATING, NOT_VIABLE, or EXCLUDED
asset_classstringFX_MAJOR, FX_CROSS, etc.
GET/symbols/tiers

Patterns grouped by performance tier.

Price

GET/price/current

Latest prices for all or specified symbols.

ParamTypeDescription
symbolsstringComma-separated symbols (e.g. EURUSD,GBPUSD)
GET/price/context/{symbol}

Price context with daily, weekly, and monthly ranges.

SSI

GET/ssi/current

Current retail positioning data for all active symbols.

Authentication

POST/auth/login

Authenticate and receive a JWT token.

POST/auth/reset-password

Request a password reset email.

Account

GET/billing/subscriptionAuthenticated

Current subscription status.

Rate Limits

EndpointLimit
POST /auth/login5/minute
POST /auth/reset-password3/minute
General API100/minute

Errors

CodeMeaning
401Missing or invalid authentication token
403Insufficient subscription tier for this endpoint
404Resource not found
422Validation error in request parameters
429Rate limit exceeded