Technical Reference
Full API Documentation
Complete endpoint reference for AlgoBoy V5.
Base URL: http://api.algoboy.com/v5/
GET
/meta/status
#1
API Health & Capability Discovery
Purpose: Prove the API is alive and show high-level capability.
Returns
- API version
- Available markets
- Data latency
- Rate limits
Why It Matters
First thing any serious client hits. Signals operational maturity.
POST
/auth/token
#2
Authentication & Access Scope
Purpose: Issue scoped access tokens.
Scopes
- market.read
- market.write
- strategy.read
- strategy.execute
- historical.read
Why It Matters
Signals institutional-grade access control. Lets you upsell tiers later.
GET
/markets/traditional
#3
Supported Markets (Traditional Finance)
Purpose: Enumerate supported financial markets.
Includes
- Equities (US, UK, EU, Asia)
- Indices
- FX (spot & forwards)
- Commodities
- Rates & bonds
- Crypto (spot & perp)
Example
- equities, fx, indices, commodities, rates, crypto
Why It Matters
Makes AlgoBoy look cross-asset, not “just betting”.
GET
/markets/betting
#4
Supported Betting & Exchange Markets
Purpose: Show exchange-style markets.
Includes
- Betting exchanges
- Fixed-odds books
- Pari-mutuel pools
Key Signal
You’re treating betting as a market, not gambling.
GET
/market-data/live
#5
Market Data (Live)
Purpose: Stream or poll live prices.
Parameters
- market_type (equities, fx, betting, crypto)
- symbol or event_id
- depth (L1, L2, full book)
Returns
- Best bid/ask
- Depth ladder
- Matched volume
- Timestamp precision
GET
/market-data/historical
#6
Market Data (Historical)
Purpose: Pull historical data for backtesting.
Parameters
- Time range
- Granularity (tick, second, minute, race-level)
- Adjustments (commission, slippage)
Why It Matters
This is the endpoint quants care about. Where research credibility lives.
GET
/sports
#7
Sports Coverage Directory
Purpose: List all supported sports.
Example Coverage
- Football (soccer)
- Horse racing & Greyhound racing
- Tennis, Basketball, American football
- Cricket, Golf, Esports, MMA / Boxing
Why It Matters
Shows scale. Makes betting data look systematic, not niche.
GET
/sports/events
#8
Sports Event & Fixture Data
Purpose: Pull events, races, matches.
Parameters
- Sport
- Region
- Date window
- Market availability
Returns
- Event metadata
- Market IDs
- Start times
- Participants
GET
/strategies
#9
Strategy Registry
Purpose: List registered algorithms.
Returns
- Strategy ID
- Asset class
- Style (momentum, arb, ML, mean reversion)
- Live / paper / research-only
Why It Matters
Positions AlgoBoy as an algorithm host, not just data pipe.
POST
/strategies/{strategy_id}/execute
#10
Strategy Execution
Purpose: Run a strategy against live or simulated markets.
Modes
- paper
- live
- replay
Controls
- Risk limits
- Max exposure
- Kill-switch flags
GET
/results/performance
#11
Results & Performance Analytics
Purpose: Pull P&L and diagnostics.
Metrics
- Gross vs net P&L
- Commission impact
- Drawdown
- Sharpe / Sortino
- Hit rate
Why It Matters
This is where trust is earned or lost.
POST
DEL
PUT
/data/...
#12
Data Management (Push / Delete / Ingest)
Purpose: Manage datasets.
Endpoints
POST /data/ingest- Push proprietary data.DELETE /data/{dataset_id}- Remove datasets.PUT /data/{dataset_id}- Update or reprocess.
Why It Matters
Signals this is a platform, not a read-only API. Enables client-owned signals.
Traditional Markets Covered (Explicit List)
| Category | Examples |
|---|---|
| Equities | NYSE, NASDAQ, LSE, Xetra |
| FX | G10, EM pairs |
| Indices | S&P, FTSE, DAX, Nikkei |
| Commodities | Oil, Gold, Gas, Ags |
| Rates | Bonds, yields, swaps |
| Crypto | BTC, ETH, perps |
Betting / Exchange Data Coverage
| Area | Detail |
|---|---|
| Exchanges | Order book, matched volume |
| Odds | Decimal, implied prob |
| Commission | Exchange-specific |
| Market microstructure | Ladder depth, cancellations |
| Race-level analytics | Traps, runners, form |
