matchbook (version 1.0.7)

mb_get_runners: Get List of Available Runners for a given Market

Description

List the Runners Available on Matchbook.com for a given Market

Usage

mb_get_runners(session_data, event_id, market_id, runner_id = NULL,
  runner_states = c("open", "suspended"), include_prices = TRUE,
  side = NULL, include_withdrawn = TRUE)

Arguments

session_data

A session object returned from a successful mb_login attempt. It contains details about your user preferences and security details.

event_id

The event_id integer for the associated market.

market_id

The market_id integer for which a list of associated runners is required.

runner_id

If you only require details for a single runner, specify this optional runner_id integer.

runner_states

A vector of string containing the runner states to return. Defaults to 'open' or 'suspended' market types.

include_prices

A boolean for returning runner prices in the response. Defaults to TRUE.

side

A filter to view the selected 'back' or 'lay' prices. The default is to return both.

include_withdrawn

A boolean for returning or not the withdrawn runners in the response. Defaults to TRUE.

Value

If successful, a dataframe with associated runner information. The data frame has the following fields:

name

Runner name

status

If betting is still available on this runner, it will have status='open'

event-id

Event id

id

Runner id

market-id

Market id

If include_prices=TRUE then available prices for each runner are returned nested within the data frame.

See Also

mb_get_sports,mb_get_events,mb_get_markets

Examples

# NOT RUN {
my_session <- mb_login("my_user_name","my_password"); 
mb_get_runners(session_data=my_session,event_id=123456,market_id=1234567)
# }
# NOT RUN {
# }