BF_Markets: Betfair markets

In vspinu/betfairly: Access Betfair API from R

Description

Functions to retrieve information about Betfair markets.

getMarket: The API GetMarket service allows the customer to input a Market ID and retrieve all static market data for the market requested. To get a Market ID for the betting market associated with an event you are interested in, use the GetEvents command.

getMarketInfo: The API GetMarketInfo service allows you to input a Market ID and retrieve market data for the market requested. To get a Market ID for the betting market associated with an event you are interested in, use the GetEvents command. This is a lite service to compliment the GetMarket service.

getMarketTradedVolume: Obtain all the current odds and matched amounts on a single runner in a particular event.

getMarketTradedVolumeCompressed: Obtain the current price (odds) and matched amounts at each price on all of the runners in a particular market.

Usage

getAllMarkets(eventTypeIds, countries, fromDate, toDate, locale,
  server = getOption("bfServer"), output = getOption("bfOutput"),
  curlOpts = list())

getMarket(marketId, includeCouponLinks = FALSE, locale = "en",
  server = getOption("bfServer"), output = getOption("bfOutput"),
  curlOpts = list())

getMarketInfo(marketId, server = getOption("bfServer"),
  output = getOption("bfOutput"), curlOpts = list())

getMarketTradedVolume(marketId, selectionId, asianLineId, currencyCode,
  server = getOption("bfServer"), output = getOption("bfOutput"),
  curlOpts = list())

getMarketTradedVolumeCompressed(marketId, currencyCode,
  server = getOption("bfServer"), output = getOption("bfOutput"),
  curlOpts = list())

Arguments

eventTypeIds	A vector with the events ids to return. If not specified, markets from all event types are returned.
countries	The countries where the event is taking place as an array of ISO3 country codes. If not specified, markets from all countries (or international markets) for the specified exchange are returned.
fromDate	Any R date-time object or string recognized by as.POSIXlt. Use asBFDateTime to see how your time input is interpreted. If this is set, the response contains only markets where the market time is not before the specified date.
toDate	Any R date-time object or string recognized by as.POSIXlt. If this is set, the response contains only markets where the market time is not after the specified date. No limit if not specified.
locale	Specify the language for the reply if you want a different language than the account default.
server	"GB" (default) or "AU" - a Betfair exchange server to use. You can set the default with options(bfServer = "AU").
output	Indicates the form of the returned value. Can be "simple" (default), "xml", "list" or "S4". See betfairly-package.
curlOpts	RCurl options passed directly to curlPerform. You can also set the defaults with options(bfCurlOpts = list(opt1 = val1, opt2 = val2, ...)).
marketId	Integer specifying the market ID.
includeCouponLinks	If you set this parameter to true, the service response contains a list of any coupons that include the market you have requested. If you set the parameter to FALSE (the default), no coupon data is returned.
locale	Specify the language for the reply if you want a different language than the account default.
server	"GB" (default) or "AU" - a Betfair exchange server to use. You can set the default with options(bfServer = "AU").
output	Indicates the form of the returned value. Can be "simple" (default), "xml", "list" or "S4". See betfairly-package.
curlOpts	RCurl options passed directly to curlPerform. You can also set the defaults with options(bfCurlOpts = list(opt1 = val1, opt2 = val2, ...)).
marketId	Integer specifying the market ID.
server	"GB" (default) or "AU" - a Betfair exchange server to use. You can set the default with options(bfServer = "AU").
output	Indicates the form of the returned value. Can be "simple" (default), "xml", "list" or "S4". See betfairly-package.
curlOpts	RCurl options passed directly to curlPerform. You can also set the defaults with options(bfCurlOpts = list(opt1 = val1, opt2 = val2, ...)).
marketId	Integer specifying the market ID.
selectionId	The desired runner id.
asianLineId	Mandatory if the market specified by Market ID is an Asian Market, otherwise optional
currencyCode	Three letter ISO 4217 code.
server	"GB" (default) or "AU" - a Betfair exchange server to use. You can set the default with options(bfServer = "AU").
output	Indicates the form of the returned value. Can be "simple" (default), "xml", "list" or "S4". See betfairly-package.
curlOpts	RCurl options passed directly to curlPerform. You can also set the defaults with options(bfCurlOpts = list(opt1 = val1, opt2 = val2, ...)).
marketId	Integer specifying the market ID.
currencyCode	Three letter ISO 4217 code.
server	"GB" (default) or "AU" - a Betfair exchange server to use. You can set the default with options(bfServer = "AU").
output	Indicates the form of the returned value. Can be "simple" (default), "xml", "list" or "S4". See betfairly-package.
curlOpts	RCurl options passed directly to curlPerform. You can also set the defaults with options(bfCurlOpts = list(opt1 = val1, opt2 = val2, ...)).

Details

getAllMarkets: Retrieve information about all of the markets that are currently active or suspended on the given exchange. You can use this service to quickly analyse the available markets on the exchange, or use the response to build a local copy of the Betfair.com navigation menu. You can limit the response to a particular time period, country where the event is taking place, and event type. Otherwise, the service returns all active and suspended markets.

Value

A data.frame containing one market per row and a character string if output = "S4".

Object of class GetMarketRespSimple which inherits from bfSimpleOutput class. Additional slot runners contains a data frame of event participants.

Object of native betfair class GetMarketResp if output = "S4".

Object of class GetMarketInfoRespSimple which inherits from bfSimpleOutput class and has no extra slots.

If output = "S4", object of native betfair class GetMarketInfoResp.

Object of class GetMarketTradedVolumeRespSimple with a slot priceItems containing a data frame of total match volumes for each odd.

Object of class GetMarketTradedVolumeCompressedRespSimple with two additional slots runners and volumes.

References

http://code.google.com/p/betfairly/, https://docs.developer.betfair.com/betfair/

See Also

betfairly-package bfSimpleOutput-class

vspinu/betfairly documentation built on May 3, 2019, 7:08 p.m.