GetSpecialLine: Get the Line for a Special Contestant
In pinnacle.API: A Wrapper for the Pinnacle API

Description Usage Arguments Details Value See Also Examples

Queries the current line and odds for a given contestant in a special.

1	GetSpecialLine(specialId, contestantId, oddsFormat = "AMERICAN")

`specialId`	The ID of the special for the contestant.
`contestantId`	The ID of the contestant.
`oddsFormat`	Format for the returned odds. One of `"AMERICAN"`, `"DECIMAL"`, `"HONGKONG"`, `"INDONESIAN"`, or `"MALAY"`.

This function will raise an error if the API does not return HTTP status OK. For information on the possible errors, see the API documentation for Get Special Line.

A data frame with the following columns:

status: When a line ID is retrieved this will contain the code "SUCCESS". Otherwise it may contain "NOT_EXISTS" or "OFFLINE".
specialId: The ID of the special.
contestantId: The ID of the contestant.
minRiskStake: Minimum bettable risk amount.
maxRiskStake: Maximum bettable risk amount.
minWinStake: Minimum bettable win amount.
maxWinStake: Maximum bettable win amount.
lineId: Line ID needed to place a bet.
price: Latest price.
handicap: Handicap value, if applicable.

See GetLine to retrieve non-special lines, GetSpecialFixtures to query available special contestants, and PlaceSpecialBet to actually wager on a contestant.

SetCredentials("TESTAPI", "APITEST")
AcceptTermsAndConditions(accepted = TRUE)

# This contest is unlikely to exist, but serves as an example
# of the format.
GetSpecialLine(specialId = 101, contestantId = 102,
               oddsFormat = "AMERICAN")