Betting Operations
Operation summary |
|
List< EventTypeResult > |
listEventTypes ( MarketFilter filter ,Stringlocale ) |
List< CompetitionResult > |
listCompetitions ( MarketFilter filter ,Stringlocale ) |
List< TimeRangeResult > |
listTimeRanges ( MarketFilter filter , TimeGranularit |
|
y granularity ) |
List< EventResult > |
listEvents ( MarketFilter filter ,Stringlocale ) |
List< MarketTypeResult > |
listMarketTypes ( MarketFilter filter ,Stringlocale ) |
List< CountryCodeResult > |
listCountries ( MarketFilter filter ,Stringlocale ) |
List< VenueResult > |
listVenues ( MarketFilter filter ,Stringlocale ) |
List< MarketCatalogue > |
listMarketCatalogue ( MarketFilter filter ,Set< Market |
|
Projection >marketProjection, MarketSort sort, int |
|
maxResults, Stringlocale ) |
List< MarketBook > |
listMarketBook ( List<String>marketIds , PriceProjec |
|
tion priceProjection, OrderProjection orderProjection, M |
|
atchProjection matchProjection,StringcurrencyCode,Str |
|
inglocale ) |
List<MarketProfitAndLoss> |
listMarketProfitAndLoss ( Set<MarketId> marketIds, |
|
boolean includeSettledBets, boolean includeBspBets, |
|
boolean netOfCommission ) |
CurrentOrderSummaryReport |
listCurrentOrders ( Set<String>betIds,Set<String>m |
|
arketIds, OrderProjection orderProjection, TimeRange |
|
placedDateRange, OrderBy orderBy, SortDir sortDir,intf |
|
romRecord,intrecordCount ) |
ClearedOrderSummaryReport |
listClearedOrders ( BetStatus betStatus, Set<Event |
|
TypeId> eventTypeIds, Set<EventId> eventIds, Set<Ma |
|
rketId> marketIds, Set<RunnerId> runnerIds, Set<BetId |
|
> betIds, Side side, TimeRange settledDateRange, Gro |
|
upBy groupBy, boolean includeItemDescription, String |
|
locale, int fromRecord, int recordCount ) |
PlaceExecutionReport |
placeOrders ( StringmarketId, List<PlaceInstruction |
|
> instructions, StringcustomerRef ) |
CancelExecutionReport |
cancelOrders ( StringmarketId, List<CancelInstructi |
|
on>instructions, StringcustomerRef ) |
ReplaceExecutionReport |
replaceOrders ( StringmarketId, List< ReplaceInstru |
|
ction> instructions, StringcustomerRef ) |
UpdateExecutionReport |
updateOrders ( StringmarketId, List< UpdateInstruc |
|
tion> instructions, StringcustomerRef ) |
listCompetitions
Operation
listCompetitions
List< CompetitionResult > listCompetitions ( MarketFilter filter ,Stringlocale ) throws APINGExcep tion
Returns a list of Competitions (i.e., World Cup 2013) associated with the markets selected by the MarketFilter. Currently only Football markets have an associated competition.
Parameter name |
Type |
Required |
Description |
filter |
MarketFilter |
|
The filter to select |
|
|
|
desired markets. All |
|
|
|
markets that match the |
|
|
|
criteria in the filter are |
|
|
|
selected. |
locale |
String |
|
The language used for |
|
|
|
the response. If not |
|
|
|
specified, the default is |
|
|
|
returned. |
Return type |
Description |
List< CompetitionResult > |
output data |
Throws |
Description |
APINGException |
Generic exception that is thrown if this operation |
|
fails for any reason. |
Since 1.0.0 |
|
listCountries |
|
Operation
listCountries
List< CountryCodeResult > listCountries ( MarketFilter filter ,Stringlocale ) throws APINGExceptio n
Returns a list of Countries associated with the markets selected by the MarketFilter.
Parameter name |
Type |
Required |
Description |
filter |
MarketFilter |
|
The filter to select |
|
|
|
desired markets. All |
|
|
|
markets that match the |
|
|
|
criteria in the filter are |
|
|
|
selected. |
locale |
String |
|
The language used for |
|
|
|
the response. If not |
|
|
|
specified, the default is |
|
|
|
returned. |
Return type |
Description |
List< CountryCodeResult > |
output data |
Throws |
Description |
APINGException |
Generic exception that is thrown if this operation |
|
fails for any reason. |
Since 1.0.0 |
|
listCurrentOrders
Operation
listCurrentOrders
CurrentOrderSummaryReport listCurrentOrders ( Set<String>betIds,Set<String>marketIds, Order Projection orderProjection, TimeRange placedDateRange, TimeRange dateRange, OrderBy order By, SortDir sortDir,intfromRecord,intrecordCount ) throws APINGException
Returns a list of your current orders. Optionally you can filter and sort your current orders using the various parameters, setting none of the parameters will return all of your current orders, up to a maximum of 1000 bets, ordered BY_BET and sorted EARLIEST_TO_LATEST. To retrieve more than 1000 orders, you need to make use of the fromRecord and recordCount parameters.
Best Practice
To efficiently track new bet matches from a specific time, customers should use a combination of the dateRange, orderBy "BY_MATCH_TIME" and orderProjection “ALL” to filter fully/partially matched orders from the list of returned bets. The response will then filter out any bet records that have no matched date and provide a list of betIds in the order which they are fully/partially matched from the date and time specified in the dateRange field.
Parameter name |
Type |
Required |
Description |
betIds |
Set<String> |
|
Optionally restricts the |
|
|
|
results to the specified |
|
|
|
bet IDs. A maximum of |
|
|
|
250 betId's, or a |
|
|
|
combination of 250 |
|
|
|
betId's & marketId's are |
|
|
|
permitted. |
marketIds |
Set<String> |
|
Optionally restricts the |
|
|
|
results to the specified |
|
|
|
market IDs. A |
|
|
|
maximum of 250 |
|
|
|
marketId's, or a |
|
|
|
combination of 250 |
|
|
|
marketId's &betId'sare |
|
|
|
permitted. |
orderProjection |
OrderProjection |
|
Optionally restricts the |
|
|
|
results to the specified |
|
|
|
order status. |
dateRange |
TimeRange |
Optionally restricts the |
|
|
results to be from/to the |
|
|
specified date, these |
|
|
dates are contextual to |
|
|
the orders being |
|
|
returned and therefore |
|
|
the dates used to filter |
|
|
on will change to |
|
|
placed, matched, |
|
|
voided or settled dates |
|
|
depending on the |
|
|
orderBy. This date is |
|
|
inclusive, i.e. if an order |
|
|
was placed on exactly |
|
|
this date (to the |
|
|
millisecond) then it will |
|
|
be included in the |
|
|
results. If the from is |
|
|
later than the to, no |
|
|
results will be returned. |
orderBy |
OrderBy |
Specifies how the |
|
|
results will be ordered. |
|
|
If no value is passed in, |
|
|
it defaults to BY_BET. |
|
|
Also acts as a filter |
|
|
such that only orders |
|
|
with a valid value in the |
|
|
field being ordered by |
|
|
will be returned (i.e. |
|
|
BY_VOID_TIME |
|
|
returns only voided |
|
|
orders, |
|
|
BY_SETTLED_TIME |
|
|
(applies to partially |
|
|
settled markets) returns |
|
|
only settled orders and |
|
|
BY_MATCH_TIME |
|
|
returns only orders with |
|
|
a matched date |
|
|
(voided, settled, |
|
|
matched orders)). Note |
|
|
that specifying an |
|
|
orderBy parameter |
|
|
defines the context of |
|
|
the date filter applied |
|
|
by the dateRange |
|
|
parameter (placed, |
|
|
matched, voided or |
|
|
settled date) - see the |
|
|
dateRange parameter |
|
|
description (above) for |
|
|
more information. See |
|
|
also the OrderBy type |
|
|
definition. |
sortDir |
SortDir |
Specifies the direction |
|
|
the results will be |
|
|
sorted in. If no value is |
|
|
passed in, it defaults to |
|
|
EARLIEST_TO_LATE |
|
|
ST. |
fromRecord |
int |
Specifies the first |
|
|
record that will be |
|
|
returned. Records start |
|
|
at index zero, not at |
|
|
index one. |