Getting Started
Welcome to the BettorEdge API Documentation! This documentation provides a complete reference for the BettorEdge REST API, which allows you to programmatically interact with our prediction markets platform.
This guide will help you understand how our prediction markets platform works and the key concepts you'll need to know to integrate with the API.
API Access Required
Before you begin: API access must be enabled on your account. If you haven't requested access yet, see the Getting Started with API Access guide to learn how to enable your account and get your API key.
What is BettorEdge?
BettorEdge is a prediction markets platform where users can buy and sell positions on the outcomes of sporting events. Unlike traditional sportsbooks where you bet against the house, BettorEdge creates a peer-to-peer marketplace where prices are determined by supply and demand.
How It Works
Think of BettorEdge like a stock market for sports:
- Markets are created for different outcomes (e.g., "Will LeBron James score over 25.5 points?")
- Prices fluctuate between $0.00 and $1.00 based on what other users are willing to buy/sell at
- You can buy or sell positions at any time before the event concludes
- Winning positions pay out $1.00 - your profit is $1.00 minus what you paid
Example
If you think LeBron James will score over 25.5 points:
- You might buy a "YES" position for $0.65
- If LeBron scores 26+ points, your position is worth $1.00
- Your profit: $1.00 - $0.65 = $0.35 profit (53.8% return)
If you want to exit early, you can sell your position back to the market at the current price.
Key Terminology
Markets
A market is a prediction about a specific outcome. Markets are binary (YES/NO) or can involve multiple outcomes. Each market has:
- A question or proposition
- A price (between $0.00 and $1.00) representing the market's consensus
- Liquidity - available positions to buy/sell
- An expiration - when the market closes
Orders
To participate in a market, you place an order. There are several types of orders:
Market Order
Buy or sell immediately at the best available price. This executes instantly against existing liquidity.
Limit Order
Set a specific price you're willing to buy or sell at. Your order will "rest" in the order book until someone takes it (or you cancel it).
H2H (Head-to-Head) Order
Challenge a specific user directly. If they accept, you both lock in that price for that trade.
Positions
When your order is filled (fully or partially), you acquire a position. Positions:
- Cost between $0.00 and $1.00
- Pay out $1.00 if your prediction is correct
- Can be sold back to the market before settlement
- Are tracked in your portfolio
- Represent the fulfilled portion of your orders
Liquidity
Liquidity refers to how much buy/sell volume is available at different price points. Markets with high liquidity are easier to enter and exit without moving the price.
Portfolio
Your portfolio shows:
- All your open positions
- Resting (unfilled) orders
- Potential winnings
- Current position value
- Cash received from sales
Balance Types
Free Market Balance
Real money you can deposit, withdraw, or use to trade. Winnings from free market trades can be withdrawn.
Promo Balance
Promotional credits that can be used to trade but cannot be withdrawn. Winnings from promo trades convert to free market balance.
Contests & Events
Markets are organized around contests (individual games or events). Each contest contains multiple tradeable markets for different outcomes within that event.
For a detailed explanation of how BettorEdge Markets work and how contests are structured, see the What are BettorEdge Markets? guide.
How Markets Are Priced
Market prices reflect probability:
- $0.50 = 50% probability
- $0.75 = 75% probability
- $0.25 = 25% probability
If you buy at $0.60 and the outcome occurs, you make $0.40 profit on a $0.60 investment (66.7% ROI).
Trading Lifecycle
- Browse Markets - Find contests and markets you want to trade
- Place Orders - Buy or sell positions at market or limit prices
- Manage Portfolio - Monitor your positions and P&L
- Exit Positions - Sell back to the market or hold until settlement
- Settlement - Markets resolve and winning positions pay $1.00
Using the API
The BettorEdge API is a REST API that accepts JSON requests and returns JSON responses. All API requests should be made to:
https://proxy.bettoredge.com
The API uses standard HTTP methods:
- GET - Retrieve data
- POST - Create or modify data
Authentication is done via Bearer tokens or API keys depending on the endpoint. See the Authentication guide for details.
Next Steps
Ready to start building with the BettorEdge API?
- Getting API Access - Request access and get your credentials
- API Reference - Explore all available endpoints
- Authentication - Learn how to authenticate requests
- Markets API - Browse and trade markets
- Players API - Manage profiles and balances
- Integration Guides - Step-by-step integration tutorials
Built with ❤️ by the BettorEdge team