-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathlinesapi-oas.yaml
3433 lines (3390 loc) · 110 KB
/
linesapi-oas.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
version: 1.0.0
title: Pinnacle - Lines API Reference
description: >
All about odds and fixtures
# Authentication
Please note that API has restriction that client password can be maximum up 10 characters long.
API uses HTTP Basic access authentication. You need to send Authorization
HTTP Request header:
`Authorization: Basic `
Example:
`Authorization: Basic U03MyOT23YbzMDc6d3c3O1DQ1`
x-logo:
url: >-
https://avatars2.githubusercontent.com/u/31601407?s=400&u=f3c6e1cfc8a26665e4a4df6d8da4a7ee527aeceb&v=4
security:
- basicAuth: []
paths:
/v1/fixtures:
get:
tags:
- Fixtures
summary: Get Fixtures - v1
description: >-
Returns all **non-settled** events for the given sport. Please note that
it is possible that the event is in Get Fixtures response but not in Get
Odds. This happens when the odds are not currently available for
wagering. Please note that it is possible to receive the same exact
response when using **since** parameter. This is rare and can be caused
by internal updates of event properties.
operationId: Fixtures_V1_Get
parameters:
- name: sportId
in: query
description: The sport id to retrieve the fixtures for.
required: true
schema:
type: integer
format: int32
- name: leagueIds
in: query
description: >-
The leagueIds array may contain a list of comma separated league
ids.
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
- name: isLive
in: query
description: >-
To retrieve ONLY live events set the value to 1 (isLive=1). Missing
or any other value will result in retrieval of events regardless of
their Live status.
required: false
schema:
type: boolean
- name: since
in: query
description: >-
This is used to receive incremental updates. Use the value of last
from previous fixtures response. When since parameter is not
provided, the fixtures are delayed up to 1 minute to encourage the
use of the parameter.
required: false
schema:
type: integer
format: int64
- name: eventIds
in: query
description: Comma separated list of event ids to filter by
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/FixturesResponse'
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendedErrorResponse'
/v1/fixtures/special:
get:
tags:
- Fixtures
summary: Get Special Fixtures - v1
description: Returns all **non-settled** specials for the given sport.
operationId: Fixtures_Special_V1_Get
parameters:
- name: sportId
in: query
description: Id of a sport for which to retrieve the specials.
required: true
schema:
type: integer
format: int32
- name: leagueIds
in: query
description: >-
The leagueIds array may contain a list of comma separated league
ids.
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
- name: since
in: query
description: >-
This is used to receive incremental updates. Use the value of last
field from the previous response. When since parameter is not
provided, the fixtures are delayed up to 1 min to encourage the use
of the parameter.
required: false
schema:
type: integer
format: int64
- name: category
in: query
description: The category the special falls under.
required: false
schema:
type: string
- name: eventId
in: query
description: Id of an event associated with a special.
required: false
schema:
type: integer
format: int64
- name: specialId
in: query
description: Id of the special.
required: false
schema:
type: integer
format: int64
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SpecialsFixturesResponse'
examples:
response:
value:
sportId: 4
last: 636433059508250600
leagues:
- id: 487
specials:
- id: 1
betType: MULTI_WAY_HEAD_TO_HEAD
name: Will the 4th quarter be odd or even?
date: '2017-10-11T14:00:00Z'
cutoff: '2017-10-11T14:00:00Z'
category: 1/4 Totals
units: ''
status: I
event:
id: 1
periodNumber: 0
contestants:
- id: 1
name: Odd
rotNum: 100
- id: 2
name: Even
rotNum: 101
- id: 2
betType: MULTI_WAY_HEAD_TO_HEAD
name: Will the 3rd quarter be odd or even?
date: '2017-10-11T14:00:00Z'
cutoff: '2017-10-11T14:00:00Z'
category: 1/4 Totals
units: ''
status: I
event:
id: 1
periodNumber: 0
contestants:
- id: 3
name: Odd
rotNum: 100
- id: 4
name: Even
rotNum: 101
- id: 3
betType: MULTI_WAY_HEAD_TO_HEAD
name: Will the 2nd quarter be odd or even?
date: '2017-10-11T14:00:00Z'
cutoff: '2017-10-11T14:00:00Z'
category: 1/4 Totals
units: ''
status: H
event:
id: 1
periodNumber: 0
contestants:
- id: 5
name: Odd
rotNum: 100
- id: 6
name: Even
rotNum: 101
- id: 4
betType: MULTI_WAY_HEAD_TO_HEAD
name: Will the 1st quarter be odd or even?
date: '2017-10-11T14:00:00Z'
cutoff: '2017-10-11T14:00:00Z'
category: 1/4 Totals
units: ''
status: I
event:
id: 1
periodNumber: 0
contestants:
- id: 7
name: Odd
rotNum: 100
- id: 8
name: Even
rotNum: 101
- id: 5
betType: MULTI_WAY_HEAD_TO_HEAD
name: Will the 4th quarter be odd or even?
date: '2017-10-11T14:00:00Z'
cutoff: '2017-10-11T14:00:00Z'
category: 1/4 Totals
units: ''
status: null
event:
id: 2
periodNumber: 0
contestants:
- id: 9
name: Odd
rotNum: 100
- id: 10
name: Even
rotNum: 101
- id: 6
betType: MULTI_WAY_HEAD_TO_HEAD
name: Will the 3rd quarter be odd or even?
date: '2017-10-11T14:00:00Z'
cutoff: '2017-10-11T14:00:00Z'
category: 1/4 Totals
units: ''
status: I
event:
id: 2
periodNumber: 0
contestants:
- id: 11
name: Odd
rotNum: 100
- id: 12
name: Even
rotNum: 101
- id: 7
betType: MULTI_WAY_HEAD_TO_HEAD
name: Will the 2nd quarter be odd or even?
date: '2017-10-11T14:00:00Z'
cutoff: '2017-10-11T14:00:00Z'
category: 1/4 Totals
units: ''
status: I
event:
id: 2
periodNumber: 0
contestants:
- id: 13
name: Odd
rotNum: 100
- id: 14
name: Even
rotNum: 101
- id: 8
betType: MULTI_WAY_HEAD_TO_HEAD
name: Will the 1st quarter be odd or even?
date: '2017-10-11T14:00:00Z'
cutoff: '2017-10-11T14:00:00Z'
category: 1/4 Totals
units: ''
status: H
event:
id: 2
periodNumber: 0
contestants:
- id: 15
name: Odd
rotNum: 100
- id: 16
name: Even
rotNum: 101
- id: 9
betType: MULTI_WAY_HEAD_TO_HEAD
name: Who will win the NBA finals?
date: '2017-10-11T14:00:00Z'
cutoff: '2017-10-11T14:00:00Z'
category: Outright Winner
units: ''
status: I
contestants:
- id: 17
name: Golden State Warriors
rotNum: 100
- id: 18
name: Cleveland Cavaliers
rotNum: 101
- id: 19
name: San Antonio Spurs
rotNum: 102
- id: 20
name: Chicago Bulls
rotNum: 103
- id: 578
specials:
- id: 10
betType: MULTI_WAY_HEAD_TO_HEAD
name: Who will win the WNBA finals?
date: '2017-10-11T14:00:00Z'
cutoff: '2017-10-11T14:00:00Z'
category: Outright Winner
units: ''
status: I
contestants:
- id: 21
name: Minnesota Lynx
rotNum: 100
- id: 22
name: Indiana Fever
rotNum: 101
- id: 23
name: Phoenix Mercury
rotNum: 102
- id: 24
name: Chicago Sky
rotNum: 103
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendedErrorResponse'
deprecated: false
/v1/fixtures/settled:
get:
tags:
- Fixtures
summary: Get Settled Fixtures - v1
description: Returns fixtures settled in the last 24 hours for the given sport.
operationId: Fixtures_Settled_V1_Get
parameters:
- name: sportId
in: query
required: true
schema:
type: integer
format: int32
- name: leagueIds
in: query
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
- name: since
in: query
required: false
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SettledFixturesSport'
examples:
response:
value:
sportId: 0
last: 0
leagues:
- id: 0
events:
- id: 0
periods:
- number: 0
status: 0
settlementId: 0
settledAt: '2017-09-03T18:21:22.3846289-07:00'
team1Score: 0
team2Score: 0
cancellationReason:
code: string
details:
correctTeam1Id: string
correctTeam2Id: string
correctListedPitcher1: string
correctListedPitcher2: string
correctSpread: '0.0'
correctTotalPoints: '0.0'
correctTeam1TotalPoints: '0.0'
correctTeam2TotalPoints: '0.0'
correctTeam1Score: '0'
correctTeam2Score: '0'
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendedErrorResponse'
/v1/fixtures/special/settled:
get:
tags:
- Fixtures
summary: Get Settled Special Fixtures - v1
description: >-
Returns all specials which are settled in the last 24 hours for the
given Sport.
operationId: Fixtures_Specials_Settled_V1_Get
parameters:
- name: sportId
in: query
description: Id of the sport for which to retrieve the settled specials.
required: true
schema:
type: integer
format: int32
- name: leagueIds
in: query
description: Array of leagueIds. This is optional parameter.
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
- name: since
in: query
description: >-
This is used to receive incremental updates. Use the value of last
from previous response.
required: false
schema:
type: integer
format: int64
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SettledSpecialsResponse'
examples:
response:
value:
sportId: 29
last: 7004137
leagues:
- id: 5200
specials:
- id : 1206517453
settlementId: 7003218
status: 3
settledAt: '2020-11-10T06:56:28.427Z'
contestants:
- id: 1206517454
name: Barranquilla
outcome: "X"
- id: 1206517455
name: Valledupar
outcome: "X"
cancellationReason:
code: FBS_CW_65
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendedErrorResponse'
deprecated: false
/v1/odds:
get:
tags:
- Odds
summary: Get Straight Odds - v1
description: >-
Returns straight odds for all non-settled events. Please note that it is possible that the event is in Get Fixtures response but not in Get Odds.
This happens when the odds are not currently available for wagering.
operationId: Odds_Straight_V1_Get
parameters:
- name: sportId
in: query
description: The sportid for which to retrieve the odds.
required: true
schema:
type: integer
format: int32
- name: leagueIds
in: query
description: >-
The leagueIds array may contain a list of comma separated league
ids.
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
- name: oddsFormat
in: query
description: >-
Format in which we return the odds. Default is American. [American,
Decimal, HongKong, Indonesian, Malay]
required: false
schema:
type: string
enum:
- American
- Decimal
- HongKong
- Indonesian
- Malay
- name: since
in: query
description: >-
This is used to receive incremental updates. Use the value of last
from previous odds response. When since parameter is not provided,
the odds are delayed up to 1 min to encourage the use of the
parameter. Please note that when using since parameter you will get
in the response ONLY changed periods. If a period did not have any
changes it will not be in the response.
required: false
schema:
type: integer
format: int64
- name: isLive
in: query
description: >-
To retrieve ONLY live odds set the value to 1 (isLive=1). Otherwise
response will have all odds.
required: false
schema:
type: boolean
- name: eventIds
in: query
description: Filter by EventIds
required: false
explode: true
schema:
type: array
items:
type: integer
format: int64
- name: toCurrencyCode
in: query
description: >-
3 letter currency code as in the
[/currency](https://pinnacleapi.github.io/linesapi#operation/Currencies_V2_Get)
response. Limits will be returned in the requested currency. Default
is USD.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OddsResponse'
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/odds/teaser:
get:
tags:
- Odds
summary: Get Teaser Odds - v1
description: Returns odds for specified teaser.
operationId: Odds_Teasers_V1_Get
parameters:
- name: teaserId
in: query
description: >-
Unique identifier.Teaser details can be retrieved from a call to Get
Teaser Groups endpoint.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TeaserOddsResponse'
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendedErrorResponse'
/v1/odds/special:
get:
tags:
- Odds
summary: Get Special Odds - v1
description: Returns odds for specials for all non-settled events.
operationId: Odds_Special_V1_Get
parameters:
- name: oddsFormat
in: query
description: >-
Format the odds are returned in. [American, Decimal, HongKong,
Indonesian, Malay]
required: false
schema:
type: string
enum:
- American
- Decimal
- HongKong
- Indonesian
- Malay
- name: sportId
in: query
description: Id of a sport for which to retrieve the specials.
required: true
schema:
type: integer
format: int32
- name: leagueIds
in: query
description: >-
The leagueIds array may contain a list of comma separated league
ids.
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
- name: since
in: query
description: >-
This is used to receive incremental updates. Use the value of last
from previous response. When since parameter is not provided, the
fixtures are delayed up to 1 min to encourage the use of the
parameter.
required: false
schema:
type: integer
format: int64
- name: specialId
in: query
description: Id of the special. This is an optional argument.
required: false
schema:
type: integer
format: int64
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SpecialOddsResponse'
examples:
response:
value:
sportId: 4
last: 636433059510590700
leagues:
- id: 487
specials:
- id: 1
maxBet: 100
contestantLines:
- id: 1
lineId: 1001
price: 4086.0
handicap: null
max: 450
- id: 2
lineId: 1002
price: 2159.0
max: 450
handicap: null
- id: 2
maxBet: 100
contestantLines:
- id: 3
lineId: 1003
price: -197
handicap: null
- id: 4
lineId: 1004
price: -196
handicap: null
- id: 3
maxBet: 100
contestantLines:
- id: 5
lineId: 1005
price: -195
handicap: null
- id: 6
lineId: 1006
price: -194
handicap: null
- id: 4
maxBet: 100
contestantLines:
- id: 7
lineId: 1007
price: -193
handicap: null
- id: 8
lineId: 1008
price: -192
handicap: null
- id: 5
maxBet: 100
contestantLines:
- id: 9
lineId: 1009
price: -191
handicap: null
- id: 10
lineId: 1010
price: -190
handicap: null
- id: 6
maxBet: 100
contestantLines:
- id: 11
lineId: 1011
price: -189
handicap: null
- id: 12
lineId: 1012
price: -188
handicap: null
- id: 7
maxBet: 100
contestantLines:
- id: 13
lineId: 1013
price: -187
handicap: null
- id: 14
lineId: 1014
price: -186
handicap: null
- id: 8
maxBet: 100
contestantLines:
- id: 15
lineId: 1015
price: -185
handicap: null
- id: 16
lineId: 1016
price: -184
handicap: null
- id: 9
maxBet: 100
contestantLines:
- id: 17
lineId: 1017
price: -183
handicap: null
- id: 18
lineId: 1018
price: -182
handicap: null
- id: 19
lineId: 1019
price: -181
handicap: null
- id: 20
lineId: 1020
price: -180
handicap: null
- id: 578
specials:
- id: 10
maxBet: 100
contestantLines:
- id: 21
lineId: 1021
price: -179
handicap: null
- id: 22
lineId: 1022
price: -178
handicap: null
- id: 23
lineId: 1023
price: -177
handicap: null
- id: 24
lineId: 1024
price: -176
handicap: null
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendedErrorResponse'
deprecated: false
/v1/line:
get:
tags:
- Line
summary: Get Straight Line - v1
description: Returns latest line.
operationId: Line_Straight_V1_Get
parameters:
- name: leagueId
in: query
description: League Id.
required: true
schema:
type: integer
format: int32
- name: handicap
in: query
description: >-
This is needed for SPREAD, TOTAL_POINTS and TEAM_TOTAL_POINTS bet
types
required: true
schema:
type: number
format: double
- name: oddsFormat
in: query
description: Format in which we return the odds. Default is American.
required: true
schema:
type: string
enum:
- American
- Decimal
- HongKong
- Indonesian
- Malay
- name: sportId
in: query