listVenues: Return Venues data

In phillc73/abettor: R bindings to Betfair API-NG

Return Venues data

Description

listVenues simply lists all venues associated with the selected parameters (e.g. horse racing venues with markets closing in the next 24 hours). Note: Currently, only horse racing markets are associated with a venue.

Usage

listVenues(
  eventTypeIds = c("7"),
  marketTypeCodes = NULL,
  fromDate = (format(Sys.time() - 7200, "%Y-%m-%dT%TZ", tz = "UTC")),
  toDate = (format(Sys.time() + 86400, "%Y-%m-%dT%TZ", tz = "UTC")),
  eventIds = NULL,
  competitionIds = NULL,
  marketIds = NULL,
  marketCountries = NULL,
  venues = NULL,
  bspOnly = NULL,
  turnInPlayEnabled = NULL,
  inPlayOnly = NULL,
  marketBettingTypes = NULL,
  withOrders = NULL,
  textQuery = NULL,
  suppress = FALSE,
  sslVerify = TRUE
)

Arguments

eventTypeIds	vector <String>. Restrict venues by event type associated with the market. (e.g., Football = 1, Horse Racing = 7, etc). Accepts multiple IDs. IDs can be obtained via listEventTypes. Optional. Default is 7 (Horse Racing).
marketTypeCodes	vector <String>. Restrict to venues that match the type of the market (i.e. MATCH_ODDS, HALF_TIME_SCORE). You should use this instead of relying on the market name as the market type codes are the same in all locales. Accepts multiple market type codes. Market type codes can be obtained via listMarketTypes. Optional. Default is NULL.
fromDate	The start date from which to return matching venues. Format is %Y-%m-%dT%TZ, tz = "UTC". Times must be submitted in UTC as this is what is used by Betfair. Optional. If not defined, it defaults to current system date and time minus 2 hours (to allow searching of all in-play football matches).
toDate	The end date to stop returning matching venues. Format is %Y-%m-%dT%TZ, tz = "UTC". Times must be submitted in UTC as this is what is used by Betfair. Optional. If not defined defaults to the current system date and time plus 24 hours.
eventIds	vector <String>. Restrict to venues that are associated with the specified eventIDs (e.g. "27675602"). Optional. Default is NULL.
competitionIds	vector <String>. Restrict to market types that are associated with the specified competition IDs (e.g. EPL = "31", La Liga = "117"). Competition IDs can obtained via listCompetitions. Optional. Default is NULL.
marketIds	vector <String>. Restrict to venues that are associated with the specified marketIDs (e.g. "1.122958246"). Optional. Default is NULL.
marketCountries	vector <String>. Restrict to venues that are in the specified country or venues. Accepts multiple country codes. Codes can be obtained via listCountries. Optional. Default is NULL.
venues	vector <String>. Restrict venues by the venue associated with the market. This functionality is currently only available for horse racing markets (e.g.venues=c("Exeter","Navan")). Optional. Default is NULL.
bspOnly	Boolean. Restrict to betfair staring price (bsp) venues only if TRUE or non-bsp events if FALSE. Optional. Default is NULL, which means that both bsp and non-bsp venues are returned.
turnInPlayEnabled	Boolean. Restrict to venues that will turn in play if TRUE or will not turn in play if FALSE. Optional. Default is NULL, which means that both venues are returned.
inPlayOnly	Boolean. Restrict to venues that are currently in play if TRUE or not inplay if FALSE. Optional. Default is NULL, which means that both inplay and non-inplay venues are returned.
marketBettingTypes	vector <String>. Restrict to venues that match the betting type of the market (i.e. Odds, Asian Handicap Singles, or Asian Handicap Doubles). Optional. Default is NULL. See https://api.developer.betfair.com/services/webapps/docs/display/1smk3cen4v3lu3yomq5qye0ni/Betting+Enums#BettingEnums-MarketBettingType for a full list (and description) of viable parameter values.
withOrders	String. Restrict to venues in which the user has bets of a specified status. The two viable values are "EXECUTION_COMPLETE" (an order that does not have any remaining unmatched portion) and "EXECUTABLE" (an order that has a remaining unmatched portion). Optional. Default is NULL.
textQuery	String. Restrict venues by any text associated with the event type, such as the Name, Event, Competition, etc. The string can include a wildcard (*) character as long as it is not the first character. Optional. Default is NULL.
suppress	Boolean. By default, this parameter is set to FALSE, meaning that a warning is posted when the listVenues call throws an error. Changing this parameter to TRUE will suppress this warning.
sslVerify	Boolean. This argument defaults to TRUE and is optional. In some cases, where users have a self signed SSL Certificate, for example they may be behind a proxy server, Betfair will fail login with "SSL certificate problem: self signed certificate in certificate chain". If this error occurs you may set sslVerify to FALSE. This does open a small security risk of a man-in-the-middle intercepting your login credentials.

Value

Response from Betfair is stored in the listVenues variable, which is then parsed from JSON as a list. Only the first item of this list contains the required event type identification details. If the listVenues call throws an error, a data frame containing error information is returned.

Note on listVenuesOps variable

The listVenuesOps variable is used to firstly build an R data frame containing all the data to be passed to Betfair, in order for the function to execute successfully. The data frame is then converted to JSON and included in the HTTP POST request.

See Also

loginBF, which must be executed first.

Examples

## Not run: 
# Return all horse racing venues (and number of
corresponding markets) for the upcoming day.
listVenues()

# Return upcoming horse racing venues in Great Britain.
listVenues(marketCountries=("GB"))

# Return upcoming venues that allow Betfair starting prices (BSPs) on
specific horse racing markets.
listVenues(bspOnly=TRUE)

## End(Not run)

phillc73/abettor documentation built on June 10, 2022, 4:43 p.m.