Skip to content

Commit 50837cf

Browse files
authored
Update README.md
1 parent decabb6 commit 50837cf

File tree

1 file changed

+67
-8
lines changed

1 file changed

+67
-8
lines changed

README.md

+67-8
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,20 @@
22

33
An API that aggregates sports betting odds/lines.
44

5-
This API is FREE and designed to be easy to read and integrate with.
5+
This API is **FREE** and designed for readability and easy integration.
6+
7+
8+
# Requests
69

710
This API is currently in beta. The two available endpoints are:
811

912
- https://thespread.azureedge.net/odds/nfl.json
1013
- https://thespread.azureedge.net/odds/college-football.json
11-
14+
15+
This API will eventually be hosted at api.thespread.io
16+
17+
# Response
18+
1219
The structure of an odds json response is similar to the following:
1320

1421
```
@@ -23,15 +30,15 @@ The structure of an odds json response is similar to the following:
2330
"Team1Money": "CHI -500",
2431
"Team2Spread": "BUF +10 (-109)",
2532
"Team2Money": "BUF +360",
26-
"OverUnder": "37.5; o: -111; u: -109"
33+
"OverUnder": "37.5 -111/-109"
2734
},
2835
{
2936
"Source": "Westgate",
3037
"Team1Spread": "CHI -10 (-110)",
3138
"Team1Money": "CHI -550",
3239
"Team2Spread": "BUF +10 (-110)",
3340
"Team2Money": "BUF +400",
34-
"OverUnder": "38; o: -110; u: -110"
41+
"OverUnder": "38 -110/-110"
3542
}
3643
]
3744
},
@@ -45,30 +52,82 @@ The structure of an odds json response is similar to the following:
4552
"Team1Money": "TB +245",
4653
"Team2Spread": "CAR -6.5 (-110)",
4754
"Team2Money": "CAR -312",
48-
"OverUnder": "54.5; o: -115; u: -105"
55+
"OverUnder": "54.5 -115/-105"
4956
},
50-
{
57+
{
5158
"Source": "Westgate",
5259
"Team1Spread": "TB +6 (-110)",
5360
"Team1Money": "TB +230",
5461
"Team2Spread": "CAR -6 (-110)",
5562
"Team2Money": "CAR -280",
56-
"OverUnder": "56; o: -110; u: -110"
63+
"OverUnder": "56 -110/-110"
5764
}
5865
]
5966
}
6067
]
6168
```
6269

70+
Notes:
71+
- Response contains Events within the past 48 hours, and known future events.
72+
- Spread, Money Line, and O/U values may contain `null`.
73+
- Not all Sources will exist for every Event.
74+
- Not all Events will always be listed.
75+
76+
## How to read the odds:
77+
78+
<br />
79+
80+
**Spread**: "`[TeamAbbreviation] [PointSpread] ([Vigorish])`"
81+
82+
| Value Part | Description |
83+
| --- | --- |
84+
| TeamAbbreviation | Shortened Team Name/Identifier. |
85+
| PointSpread | The point spread that should be applied to that team's final score.<br />ex: A value of `-5` would mean that team needs to win by more than 5 points.<br />ex: A value of `+10` would mean that team needs to lose by less than 10 points. |
86+
| Vigorish | aka: Juice, Vig, Cut, Take.<br />The amount of money to risk/lay for a $100 bet.<br />ex: A value of `-110` means a better would need to lay $110 to win $100. |
87+
88+
<br />
89+
90+
**MoneyLine**: "`[TeamAbbreviation] [MoneyLine]`"
91+
92+
| Value Part | Description |
93+
| --- | --- |
94+
| TeamAbbreviation | Shortened Team Name/Identifier. |
95+
| MoneyLine | The amount of money to risk/lay for a $100 bet.<br />ex: A value of `-500` means a better would need to lay $500 to win $100.<br />ex: A value of `+360` means a better would need to lay $100 to win $360.<br />note: Unlike a Point Spread bet, the team needs to win outright. |
96+
97+
<br />
98+
99+
**OverUnder**: "`[TotalPoints] [OverLine]/[UnderLine]`"
100+
101+
| Value Part | Description |
102+
| --- | --- |
103+
| TotalPoints | A value that represents the estimated combined final scores of both teams. The total points scored during the Event. This is the value the better is betting against, will the combined final score be over or under this value. |
104+
| OverLine | The amount of money to risk/lay for a $100 bet if the better believes the total points scored will be over/more than the TotalPoints value.<br />ex: A value of `-110` means a better would need to lay $110 to win $100. |
105+
| UnderLine | The amount of money to risk/lay for a $100 bet if the better believes the total points scored will be under/less than the TotalPoints value.<br />ex: A value of `-110` means a better would need to lay $110 to win $100. |
106+
107+
108+
<br />
109+
110+
# Data Source
111+
63112
The Odds Sources that are currently available within each file/for each event:
64113
- Caesar's
65114
- Unibet
66115
- Westgate
67116
- William Hill
68117
- Wynn
69118

119+
Note: there is no guarantee of accuracy at this time.
70120

71-
Note: there is no guarantee of accuracy at this time
72121

122+
# Roadmap
123+
124+
Short roadmap of future enhancements:
125+
- Include 'open' values
126+
- Include 'last change date' values and previous value
127+
- Include local event time in addition to UTC time
128+
- Include complete history of lines for a single event
129+
130+
# Questions/Comments
73131

74132
Please feel free to open issues with any questions you may have.
133+

0 commit comments

Comments
 (0)