-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathbetsapi.v4-oas.yaml
2402 lines (2396 loc) · 86.5 KB
/
betsapi.v4-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.1
info:
title: Pinnacle - Bets API Reference
description: "All about bets, place bets, get your bet history or current bet status.\n\
\n# Authentication \n\nPlease note that API has restriction that client password\
\ can be maximum up 10 characters long.\n \nAPI uses HTTP Basic access authentication.\
\ You need to send Authorization HTTP Request header: \n\n`Authorization: Basic\
\ <Base64 value of UTF-8 encoded \"username:password\">`\n\nExample:\n\n`Authorization:\
\ Basic U03MyOT23YbzMDc6d3c3O1DQ1`\n"
version: 4.0.0
x-logo:
url: https://avatars2.githubusercontent.com/u/31601407?s=400&u=f3c6e1cfc8a26665e4a4df6d8da4a7ee527aeceb&v=4
servers:
- url: https://api.pinnacle.com/
security:
- basicAuth: []
paths:
/v4/bets/straight:
post:
tags:
- Place Bets
summary: Place straight bet
description: |
Place straight bet (SPREAD, MONEYLINE, TOTAL_POINTS, TEAM_TOTAL_POINTS).
Please note when the status is PENDING_ACCEPTANCE and if the live delay was applied, the response will not have betId. Client would have to call /bets by uniqueRequestId to check the status if the bet was ACCEPTED. For more details please see [How to place a bet on live events?](https://github.com/pinnacleapi/pinnacleapi-documentation/blob/master/FAQ.md#how-to-place-a-bet-on-live-events)
Make sure you handle properly the case of an unexpected error as per
[How to handle error on placing a bet?](https://github.com/pinnacleapi/pinnacleapi-documentation/blob/master/FAQ.md#how-to-handle-unexpected-error-on-placing-a-bet)
operationId: Bets_StraightV2
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PlaceBetRequest'
required: true
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PlaceStraightBetResponse'
examples:
Accepted Bet:
value:
betId: 759629245
status: ACCEPTED
uniqueRequestId: ebb4c11a-714b-4be6-a635-486ec09869a3
win: 20.06
risk: 11.73
price: 171
betterLineWasAccepted: false
Live Bet Pending Acceptance:
value:
status: PENDING_ACCEPTANCE
uniqueRequestId: 41812e84-132e-499e-9b21-a6d0a8ad06a4
Bet Processed With An Error:
value:
status: PROCESSED_WITH_ERROR
errorCode: LINE_CHANGED
uniqueRequestId: 33cdb889-5ff0-4ce1-b9a1-8a9f00248512
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/ErrorResponseWithErrorRef'
x-codegen-request-body-name: request
/v4/bets/parlay:
post:
tags:
- Place Bets
summary: Place parlay bet.
description: |2
Make sure you handle properly the case of an unexpected error as per
[How to handle error on placing a bet?](https://github.com/pinnacleapi/pinnacleapi-documentation/blob/master/FAQ.md#how-to-handle-unexpected-error-on-placing-a-bet)
operationId: Bets_ParlayV2
requestBody:
description: The Parlay request.
content:
application/json:
schema:
$ref: '#/components/schemas/PlaceParlayBetRequest'
required: true
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PlaceParlayBetResponse'
examples:
Accepted Bet:
value:
betId: 1525403345
status: ACCEPTED
uniqueRequestId: ebb4c11a-714b-4be6-a635-486ec09869a3
roundRobinOptionWithOdds:
- roundRobinOption: Parlay
odds: 1.837
unroundedDecimalOdds: 1.8375214328289233
- roundRobinOption: TwoLegRoundRobin
odds: 2.512
unroundedDecimalOdds: 2.512755833653531
maxRiskStake: 7142.78
minRiskStake: 4.76
validLegs:
- status: VALID
errorCode: null
legId: 4ec00aa7-2732-58ea-345a-b355b7b5ac01
lineId: 1633933741
price: 1.228
- status: VALID
errorCode: null
legId: c7820725-2841-2449-21ee-875dd08fb0cc
lineId: 1633614701
price: 1.337
- status: VALID
errorCode: null
legId: 4f3387fe-0bdd-f8a7-2a0e-58a2d59f4764
lineId: 1633863439
price: 1.118
Live Bet Pending Acceptance:
value:
status: PENDING_ACCEPTANCE
uniqueRequestId: 41812e84-132e-499e-9b21-a6d0a8ad06a4
Bet Processed With An Error:
value:
status: PROCESSED_WITH_ERROR
errorCode: INVALID_LEGS
betId: null
uniqueRequestId: e5d6a297-70ff-49a7-b854-c4ac3c616e57
roundRobinOptionWithOdds:
- roundRobinOption: Parlay
odds: 156
unroundedDecimalOdds: 2.5619967793880836
maxRiskStake: 160256.41
minRiskStake: 0.01
validLegs:
- status: VALID
errorCode: null
legId: dad6dcaf-7452-4177-81c9-741fd326c5fb
lineId: 1633267012
price: -270
invalidLegs:
- status: PROCESSED_WITH_ERROR
errorCode: LINE_CHANGED
legId: 97e108f9-de39-4c87-96b5-a1c7748a39c1
lineId: 1633395088
price: -115
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/ErrorResponseWithErrorRef'
x-codegen-request-body-name: request
/v4/bets/teaser:
post:
tags:
- Place Bets
summary: Place teaser bet.
description: |
Make sure you handle properly the case of an unexpected error as per
[How to handle error on placing a bet?](https://github.com/pinnacleapi/pinnacleapi-documentation/blob/master/FAQ.md#how-to-handle-unexpected-error-on-placing-a-bet)
operationId: Bets_Teaser
requestBody:
description: The PlaceTeaser request.
content:
application/json:
schema:
$ref: '#/components/schemas/PlaceTeaserBetRequest'
required: true
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PlaceTeaserBetResponse'
examples:
Accepted Bet:
value:
status: ACCEPTED
errorCode: null
betId: 945160306
uniqueRequestId: b2c279bc-f046-48f8-b4e2-cc6dc4c4ae93
price: -110
risk: 10
win: 9.09
validLegs:
- status: VALID
errorCode: null
legId: b1f3de18-a9b6-4c51-b99b-af0e071e7f6f
lineId: 1633999451
points: 3.5
- status: VALID
errorCode: null
legId: 466c1016-4d28-4cfa-b5d8-8c1b11b046d2
lineId: 1634014962
points: -6.5
Bet Processed With An Error:
value:
status: PROCESSED_WITH_ERROR
errorCode: INVALID_LEGS
betId: null
uniqueRequestId: ef76dc6e-73c6-4905-bed2-8c9d408a2bf7
invalidLegs:
- status: PROCESSED_WITH_ERROR
errorCode: LINE_IS_NOT_AVAILABLE
legId: 38460773-aafc-48fd-a939-e0d9ce1b6807
validLegs:
- status: VALID
errorCode: null
legId: 3256398d-3b18-4c2b-b856-20fba8e371ab
lineId: 1634029355
points: 8.5
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/ErrorResponseWithErrorRef'
x-codegen-request-body-name: request
/v4/bets/special:
post:
tags:
- Place Bets
summary: Place specials bet.
description: |
Make sure you handle properly the case of an unexpected error as per
[How to handle error on placing a bet?](https://github.com/pinnacleapi/pinnacleapi-documentation/blob/master/FAQ.md#how-to-handle-unexpected-error-on-placing-a-bet)
operationId: Bets_Special
requestBody:
description: The SpecialBet request.
content:
application/json:
schema:
$ref: '#/components/schemas/MultiBetRequest.SpecialBetRequest'
examples:
Accepted Bet:
value:
betId: 759629245
status: ACCEPTED
uniqueRequestId: ebb4c11a-714b-4be6-a635-486ec09869a3
win: 20.06
risk: 11.73
price: 171
betterLineWasAccepted: false
Live Bet Pending Acceptance:
value:
status: PENDING_ACCEPTANCE
uniqueRequestId: 41812e84-132e-499e-9b21-a6d0a8ad06a4
Bet Processed With An Error:
value:
status: PROCESSED_WITH_ERROR
errorCode: LINE_CHANGED
uniqueRequestId: 33cdb889-5ff0-4ce1-b9a1-8a9f00248512
required: true
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MultiBetResponse.SpecialBetResponse'
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/ErrorResponseWithErrorRef'
x-codegen-request-body-name: request
/v4/bets:
get:
tags:
- Get Bets
summary: Get Bets - v4
description: "Returns bets. \n\n\n### Get running bets by time range:\n```\n\
https://api.pinnacle.com/v4/bets?betlist=RUNNING&fromDate=2017-11-21T00:00:00Z&toDate=2017-11-29T00:00:00Z\n\
```\nRunning bets are queried by *placedAt* date time\n\n\n### Get settled\
\ bets by time range:\n \n```\nhttps://api.pinnacle.com/v4/bets?betlist=SETTLED&fromDate=2015-12-28T00:00:00Z&toDate=2015-12-29T00:00:00Z\n\
```\nSettled bets are queried by *settledAt* date time\nhttps://api.pinnacle.com/v4/bets?betlist=SETTLED&fromDate=2017-11-20T00:00:00Z&toDate=2017-11-23T00:00:00Z\n\
\n\n### Get settled cancelled bets by time range:\n \n```\nhttps://api.pinnacle.com/v4/bets?betList=SETTLED&fromDate=2018-03-01&toDate=2018-03-28&betStatuses=CANCELLED\n\
```\n\n\n### Get bets by bet ids:\n\n```\nhttps://api.pinnacle.com/v4/bets?betIds=775856112,775856113,775856114\n\
```\n\n### Get bets by uniqueRequestIds:\n\n```\nhttps://api.pinnacle.com/v4/bets?uniqueRequestIds=62335222-dae4-479a-8c05-46440ccdd3bb,42335222-dae4-479a-8c05-46440ccdd3bb\n\
```\n"
operationId: Bets_GetBetsByTypeV4
parameters:
- name: betlist
in: query
description: Type of bet list to return. Not needed when betids is submitted.
schema:
type: string
enum:
- SETTLED
- RUNNING
- ALL
- name: betStatuses
in: query
description: Type of bet statues to return. This works only in conjustion
with betlist, as additional filter.
style: form
explode: false
schema:
type: array
items:
type: string
enum:
- WON
- LOSE
- CANCELLED
- REFUNDED
- NOT_ACCEPTED
- ACCEPTED
- PENDING_ACCEPTANCE
- name: fromDate
in: query
description: |
Start date of the requested period. Required when betlist parameter is submitted. Start date can be up to 30 days in the past. Expected format is ISO8601 - can be set to just date or date and time.
schema:
type: string
- name: toDate
in: query
description: |
End date of the requested period. Required when betlist parameter is submitted. Expected format is ISO8601 - can be set to just date or date and time. toDate value is exclusive, meaning it cannot be equal to fromDate.
schema:
type: string
- name: sortDir
in: query
description: Sort direction by postedAt/settledAt. Respected only when querying
by date range.
schema:
type: string
default: ASC
enum:
- ASC
- DESC
- name: pageSize
in: query
description: Page size in case. Max is 1000. Respected only when querying
by date range.
schema:
type: integer
default: 1000
- name: fromRecord
in: query
description: 'Starting record (inclusive) of the result. Respected only when
querying by date range. To fetch next page set it to toRecord+1 '
schema:
type: integer
default: 0
- name: betids
in: query
description: A comma separated list of bet ids. When betids is submitted,
no other parameter is necessary. Maximum is 100 ids. Works for all non settled
bets and all bets settled in the last 30 days.
style: form
explode: false
schema:
type: array
items:
type: integer
format: int64
- name: uniqueRequestIds
in: query
description: "A comma separated list of `uniqueRequestId` from the place bet\
\ request. If specified, it's highest priority, all other parameters are\
\ ignored. Maximum is 10 ids. If client has bet id, preferred way is to\
\ use `betIds` query parameter, you can use `uniqueRequestIds` when you\
\ do not have bet id. \nThat are 2 cases when client may not have a bet\
\ id:\n\n1. When you bet on live event with live delay, place bet response\
\ in that case does not return bet id, so client can query bet status by\
\ `uniqueRequestIds`.\n2. In case of any network issues when client is not\
\ sure what happened with his place bet request. Empty response means that\
\ the bet was not placed. Please check [Deduplication section](https://www.pinnacle.com/de/api/manual#overview)\
\ for more details.\n\nNote that there is a restriction: querying by uniqueRequestIds\
\ is supported for straight and special bets and only up to 30 min from\
\ the moment the bet was place. \n"
style: form
explode: false
schema:
type: array
items:
type: string
- name: betType
in: query
description: A comma separated list of bet types.
style: form
explode: false
schema:
type: array
items:
type: string
enum:
- SPREAD
- MONEYLINE
- TOTAL_POINTS
- TEAM_TOTAL_POINTS
- SPECIAL
- PARLAY
- TEASER
- MANUAL
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetBetsByTypeResponseV4'
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/ErrorResponseWithErrorRef'
/v4/bets/betting-status:
get:
tags:
- Betting Status
summary: Get Betting Status
description: Returns current betting status. During maintenance windows betting
could be disabled, you can call this operation to check the current betting
status.
operationId: Bets_GetBettingStatus
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BettingStatusResponse'
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/ErrorResponseWithErrorRef'
components:
schemas:
PlaceBetRequest:
type: object
properties:
oddsFormat:
$ref: '#/components/schemas/OddsFormat'
uniqueRequestId:
type: string
description: This is a Unique ID for PlaceBet requests. This is to support
idempotent requests.
format: uuid
example: d5cc50e4-284d-4d50-8d49-429bdc4f2a48
acceptBetterLine:
type: boolean
description: Whether or not to accept a bet when there is a line change
in favor of the client.
example: true
stake:
type: number
description: amount in client’s currency.
format: double
example: 10.5
winRiskStake:
type: string
description: Whether the stake amount is risk or win amount.
example: RISK
enum:
- WIN
- RISK
lineId:
type: integer
description: Line identification.
format: int64
example: 420921914
altLineId:
type: integer
description: Alternate line identification.
format: int64
nullable: true
fillType:
type: string
description: "NORMAL - bet will be placed on specified stake. \nFILLANDKILL\
\ - If the stake is over the max limit, bet will be placed on max limit,\
\ otherwise it will be placed on specified stake. \nFILLMAXLIMIT - bet\
\ will be places on max limit, stake amount will be ignored. Please note\
\ that maximum limits can change at any moment, which may result in risking\
\ more than anticipated. This option is replacement of isMaxStakeBet from\
\ v1/bets/place'\n"
example: NORMAL
default: NORMAL
enum:
- NORMAL
- FILLANDKILL
- FILLMAXLIMIT
sportId:
type: integer
format: int32
example: 29
eventId:
type: integer
format: int64
example: 757504261
periodNumber:
type: integer
format: int32
example: 0
betType:
type: string
description: Bet type.
example: MONEYLINE
enum:
- MONEYLINE
- TEAM_TOTAL_POINTS
- SPREAD
- TOTAL_POINTS
team:
type: string
description: Team type.
example: TEAM1
enum:
- TEAM1
- TEAM2
- DRAW
side:
type: string
description: Side type.
nullable: true
example: null
enum:
- OVER
- UNDER
description: Request to place a bet.
ErrorResponse:
type: object
properties:
code:
type: string
description: "INVALID_REQUEST_DATA = Invalid request parameters (http status\
\ 400) \nINVALID_CREDENTIALS = Authorization failed, invalid credentials\
\ (http status 401) \nINVALID_AUTHORIZATION_HEADER = HTTP Authorization\
\ header is missing (http status 401) \nACCOUNT_INACTIVE = Client's account\
\ is not active (http status 403) \nNO_API_ACCESS = Account not permitted\
\ to access the API (http status 403) \nRESUBMIT_REQUEST = It can happen\
\ only when placing a bet (http status 400). Unable to process the request\
\ but the request itself is valid. This happens more often on the live\
\ betting in situations when there is more than one place bet request\
\ at the same on the same line. When this happens, we don't keep the place\
\ bet request on the server until we know if we can accept or reject the\
\ bet, but instead we return the error. It's also very likely that the\
\ line will change after that. To reduce a chance of getting RESUBMIT_REQUEST\
\ client should try to place a bet as fast as possible. \n"
enum:
- INVALID_REQUEST_DATA
- INVALID_CREDENTIALS
- INVALID_AUTHORIZATION_HEADER
- ACCOUNT_INACTIVE
- NO_API_ACCESS
- RESUBMIT_REQUEST
message:
type: string
PlaceStraightBetResponse:
type: object
properties:
status:
type: string
description: Status of the response.
example: ACCEPTED
enum:
- ACCEPTED
- PENDING_ACCEPTANCE
- PROCESSED_WITH_ERROR
errorCode:
type: string
description: "If Status is PROCESSED_WITH_ERROR, errorCode will be in the\
\ response. \n\nALL_BETTING_CLOSED = Betting is not allowed at this moment.\
\ This may happen during system maintenance, \nALL_LIVE_BETTING_CLOSED\
\ = Live betting is not allowed at this moment. This may happen during\
\ system maintenance, \nABOVE_EVENT_MAX = Bet cannot be placed because\
\ client exceeded allowed maximum of risk on a line, \nABOVE_MAX_BET_AMOUNT\
\ = Stake is above allowed maximum amount, \nBELOW_MIN_BET_AMOUNT =\
\ Stake is below allowed minimum amount, \nBLOCKED_BETTING = Betting\
\ is suspended for the client, \nBLOCKED_CLIENT = Client is no longer\
\ active, \nINSUFFICIENT_FUNDS = Bet is submitted by a client with insufficient\
\ funds, \nINVALID_COUNTRY = Client country is not allowed for betting,\
\ \nINVALID_EVENT = Invalid eventid, \nINVALID_ODDS_FORMAT = If a bet\
\ was submitted with the odds format that is not allowed for the client,\
\ \nLINE_CHANGED = Bet is submitted on a line that has changed, \n\
OFFLINE_EVENT = Bet is submitted on an event that is offline or the submitted\
\ line is not offered at the moment due to points/handicap change or the\
\ submitted bet type is just not offered at the moment, \nPAST_CUTOFFTIME\
\ = Bet is submitted on a game after the betting cutoff time, \nRED_CARDS_CHANGED\
\ = Bet is submitted on a live soccer event with changed red card count,\
\ \nSCORE_CHANGED = Bet is submitted on a live soccer event with changed\
\ score, \nTIME_RESTRICTION = Bet is submitted within too short of a\
\ period from the same bet previously placed by a client, \nDUPLICATED_REQUEST\
\ = Request with the same uniqueRequestId was already processed. Please\
\ set the new value if you still want the request to be processed, \n\
INCOMPLETE_CUSTOMER_BETTING_PROFILE = System configuration issue, \n\
INVALID_CUSTOMER_PROFILE = System configuration issue, \nLIMITS_CONFIGURATION_ISSUE\
\ = System configuration issue, \nRESPONSIBLE_BETTING_LOSS_LIMIT_EXCEEDED\
\ = Client has reached his total loss limit, \nRESPONSIBLE_BETTING_RISK_LIMIT_EXCEEDED\
\ = Client has reached his total risk limit, \nSYSTEM_ERROR_3 = Unexpected\
\ error, \nLICENCE_RESTRICTION_LIVE_BETTING_BLOCKED - Live betting blocked\
\ due to licence restrictions, \nBETTING_SUSPENDED - Due to anomalous market circumstances bets\
\ are not currently being accepted on this line. Try again with next LineId.\n"
nullable: true
example: null
enum:
- ALL_BETTING_CLOSED
- ALL_LIVE_BETTING_CLOSED
- ABOVE_EVENT_MAX
- ABOVE_MAX_BET_AMOUNT
- BELOW_MIN_BET_AMOUNT
- BLOCKED_BETTING
- BLOCKED_CLIENT
- INSUFFICIENT_FUNDS
- INVALID_COUNTRY
- INVALID_EVENT
- INVALID_ODDS_FORMAT
- LINE_CHANGED
- LISTED_PITCHERS_SELECTION_ERROR
- OFFLINE_EVENT
- PAST_CUTOFFTIME
- RED_CARDS_CHANGED
- SCORE_CHANGED
- TIME_RESTRICTION
- DUPLICATED_REQUEST
- INCOMPLETE_CUSTOMER_BETTING_PROFILE
- INVALID_CUSTOMER_PROFILE
- LIMITS_CONFIGURATION_ISSUE
- RESPONSIBLE_BETTING_LOSS_LIMIT_EXCEEDED
- RESPONSIBLE_BETTING_RISK_LIMIT_EXCEEDED
- SYSTEM_ERROR_3
- LICENCE_RESTRICTION_LIVE_BETTING_BLOCKED
- BETTING_SUSPENDED
uniqueRequestId:
type: string
description: Echo of the uniqueRequestId from the request.
example: D5CC50E4-284D-4D50-8D49-429BDC4F2A4
betId:
type: integer
description: Bet identification. Populated in case of accepted bet.
format: int64
example: 759629245
win:
type: number
description: Win amount. Populated in case of accepted bet.
format: double
example: 1.0
risk:
type: number
description: Risk amount. Populated in case of accepted bet.
format: double
example: 1.5
price:
type: number
description: Bet price. Populated in case of accepted bet.
format: double
example: -155.0
betterLineWasAccepted:
type: boolean
description: Whether or not the bet was accepted on the line that changed
in favour of client. This can be true only if `acceptBetterLine` in the
Place Bet request is set to TRUE.
example: false
StraightBetV4:
required:
- betId
- betStatus
- betType
- oddsFormat
- placedAt
- risk
- updateSequence
- wagerNumber
- win
type: object
properties:
betId:
type: integer
description: Bet identification
format: int64
example: 759629245
wagerNumber:
type: integer
description: Wager identification. All bets placed thru the API will have
value 1. Website Classic view supports multiple contest(special) bets
placement in the same bet slip in that case the bet would have appropriate
wager number, as well as all round robin parlay bets.
format: int32
example: 1
placedAt:
type: string
description: Date time when the bet was placed.
format: date-time
example: 2017-09-05T01:32:59Z
betStatus:
type: string
description: "Bet Status. \n\nACCEPTED = Bet was accepted.\nPUSHED = Bet\
\ was pushed.\nCANCELLED = Bet is cancelled as per Pinnacle betting rules.\
\ \nLOST = The bet is settled as lose. \nPENDING_ACCEPTANCE = This status\
\ is reserved only for live bets. If a live bet is placed during danger\
\ zone or live delay is applied, it will be in PENDING_ACCEPTANCE , otherwise\
\ in ACCEPTED status. From this status bet can go to ACCEPTED or NOT_ACCEPTED\
\ status. \nREFUNDED = When an event is cancelled or when the bet is\
\ settled as push, the bet will have REFUNDED status. \nNOT_ACCEPTED\
\ = Bet was not accepted. Bet can be in this status only if it was previously\
\ in PENDING_ACCEPTANCE status. \nWON = The bet is settled as won. \n\
HALF_WON_HALF_PUSHED = The bet is settled as half won half pushed. Only\
\ for asian handicap bets. \nHALF_LOST_HALF_PUSHED = The bet is settled\
\ as half lost half pushed. Only for asian handicap bets.\n"
example: ACCEPTED
enum:
- ACCEPTED
- CANCELLED
- LOST
- PENDING_ACCEPTANCE
- REFUNDED
- PUSHED
- NOT_ACCEPTED
- WON
- HALF_WON_HALF_PUSHED
- HALF_LOST_HALF_PUSHED
betType:
type: string
description: Bet type.
example: MONEYLINE
enum:
- MONEYLINE
- TEAM_TOTAL_POINTS
- SPREAD
- TOTAL_POINTS
- SPECIAL
- PARLAY
- TEASER
- MANUAL
win:
type: number
description: Win amount.
format: double
example: 1.0
risk:
type: number
description: Risk amount.
format: double
example: 1.5
winLoss:
type: number
description: Win-Loss for settled bets.
format: double
nullable: true
oddsFormat:
$ref: '#/components/schemas/OddsFormat'
customerCommission:
type: number
description: Client’s commission on the bet.
format: double
nullable: true
cancellationReason:
$ref: '#/components/schemas/CancellationReason'
updateSequence:
type: integer
description: Update Sequence
format: int64
example: 111548915
sportId:
type: integer
description: ""
format: int32
example: 29
leagueId:
type: integer
description: ""
format: int32
example: 2462
eventId:
type: integer
description: ""
format: int64
example: 757064557
handicap:
type: number
description: ""
format: double
nullable: true
price:
type: number
description: ""
format: double
example: -155.0
teamName:
type: string
description: ""
example: Crvena Zvezda
side:
type: string
description: Side type.
nullable: true
example: null
enum:
- OVER
- UNDER
team1:
type: string
description: ""
example: Crvena Zvezda
team2:
type: string
description: ""
example: Partizan
periodNumber:
type: integer
description: ""
format: int32
example: 0
team1Score:
type: number
description: Team 1 on the period that the bet was placed on at the moment
of placing a bet, only for live bets.
format: double
nullable: true
team2Score:
type: number
description: Team 2 on the period that the bet was placed on at the moment
of placing a bet, only for live bets.
format: double
nullable: true
ftTeam1Score:
type: number
description: Full time team 1 score, only for settled bets.
format: double
nullable: true
ftTeam2Score:
type: number
description: Full time team 2 score, only for settled bets.
format: double
nullable: true
pTeam1Score:
type: number
description: '.End of period team 1 score, only for settled bets. If the
bet was placed on Game period (periodNumber =0), this will be null . '
format: double
nullable: true
pTeam2Score:
type: number
description: End of period team 2 score, only for settled bets. If the bet
was placed on Game period (periodNumber =0), this will be null
format: double
nullable: true
isLive:
type: boolean
description: Whether the bet is on live event
example: false
eventStartTime:
type: string
description: Date time when the event starts.
format: date-time
example: 2017-10-05T01:32:59Z
description: ""
CancellationReason:
required:
- code
type: object
properties:
code:
type: string
example: FBS_CW_227
details:
$ref: '#/components/schemas/CancellationDetails'
description: "Possible keys \\: \n* correctTeam1Id\n* correctTeam2Id\n* correctListedPitcher1\n\
* correctListedPitcher2\n* correctSpread\n* correctTotalPoints\n* correctTeam1TotalPoints\n\
* correctTeam2TotalPoints\n* correctTeam1Score\n* correctTeam2Score\n* correctTeam1TennisSetsScore\n\
* correctTeam2TennisSetsScore\n"
CancellationDetails:
type: array
example:
- key: correctSpread
value: -1.5
items:
$ref: '#/components/schemas/CancellationDetailsItem'
CancellationDetailsItem:
type: object
properties:
key:
type: string
example: correctSpread
value:
type: string