Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Gem for interacting with the Betfair Betting Exchange API

branch: master
README.md

BETFAIR API

Install the gem

Install it with RubyGems

  gem install betfair

or add this to your Gemfile if you use Bundler:

  gem 'betfair'    

Introduction

In a irb console

require 'betfair'

From a Gemfile

gem 'betfair'

Load the general api class

bf = Betfair::API.new

If you want to use a proxy or turn on Savon's logging then just pass in like so:

This is a local squid proxy I tunnel to from my local machine to access the host server in UK for dev purposes.

proxy = 'http://localhost:8888' 
logging = true
bf = Betfair::API.new(proxy, logging)

Proxies can be useful if you want to host on a cloud service such as Heroku, as you will be denied access to the Betfair API from the USA. Just proxy via a server from a country that Betfair allows, such as the UK.

General API METHODS

Login

At the heart of the Betfair API is the session_token. In order to get one of these simply call:

username            = 'foo'
password            = 'bar'
product_id          = 82
vendor_software_id  = 0
location_id         = 0
ip_address          = nil

session_token = bf.login(username, password, product_id, vendor_software_id, location_id, ip_address)

The session_token value you get back responds to #success? which will tell you whether login was successful or not. If session_token.success? returns false, session_token.to_s will give you the error message.

The standard product_id is 82, you may have a different one depending on the level of Betfair API access that you have.

Logout

It is considered good API etiquette to logout once you are done.

foo = bf.logout(session_token)

Keep Alive

Your session_token will expire after 20 mins of inactivity. Supposedly the token gets refreshed with every API call you make, but I am not convinced of this. This call will refresh it for another 20 mins.

session_token = bf.keep_alive(session_token)

Read-Only Betting API METHODS

Get All Markets

The API GetAllMarkets service allows you to retrieve information about all of the markets that are currently active or suspended on the given exchange.

exchange_id     = 1       # 1 == UK, 2 == AUS
event_type_ids  = [1,3]   # Full list here http://data.betfair.com/sportids.htm
locale          = nil 
countries       = nil 
from_date       = Time.now.utc
to_date         = 30.minutes.from_now.utc

markets = 
  bf.get_all_markets(session_token, exchange_id, event_type_ids, locale, countries, from_date, to_date)

Get MU Bets

The API GetMUBets service allows you to retrieve information about all your matched and unmatched bets on a particular exchange server.

exchange_id   = 1
market_id     = 12345
bet_status    = 'MU'
start_record  = 0
record_count  = 200
sort_order    = 'ASC'
order_by      = 'PLACED_DATE'

mu_bets =
  bf.get_mu_bets(session_token, exchange_id, market_id, bet_status, start_record, record_count, sort_order, order_by)

Get Market

The API GetMarket service allows the customer to input a Market ID and retrieve all static market data for the market requested.

exchange_id   = 1
market_id     = 12345
locale        = nil

market 
  = bf.get_market(session_token, exchange_id, market_id, locale)

Get Market Prices Compressed

The API GetMarketPricesCompressed service allows you to retrieve dynamic market data for a given Market ID in a compressed format.

exchange_id       = 1
market_id         = 12345
currency_code     = nil

price = 
  bf.get_market_prices_compressed(session_token, exchange_id, market_id, currency_code)

Get Active Event Types

The API GetAllEventTypes service allows the customer to retrieve lists of all categories of sports (Games, Event Types) that have at least one market associated with them, regardless of whether that market is now closed for betting.

locale = nil

active_event_types = 
  bf.get_active_event_types(session_token, locale)

Get Account Funds

The API GetAccountFunds service allows you to retrieve information about your local wallet on a particular exchange server.

exchange_id = 1

funds = 
  bf.get_account_funds(session_token, exchange_id)

Bet Placement API METHODS

Place Bet

The API PlaceBets service allows you to place multiple (1 to 60) bets on a single Market.

exchange_id     = 1
market_id       = 122435
selection_id    = 58805
bet_type        = 'B' # Or L for Lay
price           = 2.0
size            = 2.0

place_bet = 
  bf.place_bet(session_token, exchange_id, market_id, selection_id, bet_type, price, size) 

Place Multiple Bets

The API PlaceBets service allows you to place multiple (1 to 60) bets on a single Market.

exchange_id     = 1
bets            = []
bets <<  { market_id: 12345, selection_id: 58805, bet_type: 'B', price: 2.0, size: 2.0, asian_line_id: 0, 
            bet_category_type: 'E', bet_peristence_type: 'NONE', bsp_liability: 0 }
bets <<  { market_id: 12345, selection_id: 1234, bet_type: 'L', price: 1.5, size: 2.0, asian_line_id: 0, 
              bet_category_type: 'E', bet_peristence_type: 'NONE', bsp_liability: 0 }

place_multiple_bets =               
  bf.place_multiple_bets(session_token, exchange_id, bets)

Update Bet

The API UpdateBets service allows you to edit multiple (1 to 15) bets on a single Market.

exchange_id               = 1
bet_id                    = 1234, 
new_bet_persistence_type  = 'NONE'
new_price                 = 10.0
new_size                  = 10.0 
old_bet_persistence_type  = 'NONE'
old_price                 = 5.0
old_size                  = 5.0

update_bet = 
  bf.update_bet(session_token, exchange_id, bet_id, new_bet_persistence_type, new_price, new_size, old_bet_persistence_type, old_price, old_size)

Update Multiple Bets

The API UpdateBets service allows you to edit multiple (1 to 15) bets on a single Market.

exchange_id = 1
bets        = []
bets << { bet_id: 1234, new_bet_persistence_type: 'NONE', new_price: 10.0, new_size: 10.0, 
          old_bet_persistence_type: 'NONE', old_price: 5.0, old_size: 5.0 }
bets << { bet_id: 1235, new_bet_persistence_type: 'NONE', new_price: 2.0, new_size: 10.0, 
          old_bet_persistence_type: 'NONE', old_price: 5.0, old_size: 5.0 }     

update_multiple_bets  =
 bf.update_multiple_bets(session_token, exchange_id, bets)

Cancel Bet

The API CancelBets service allows you to cancel multiple unmatched (1 to 40) bets placed on a single Market.

exchange_id   = 1
bet_id        = 1235

cancel_bet = 
  bf.cancel_bet(session_token, exchange_id, bet_id)

Cancel Multiple Bets

The API CancelBets service allows you to cancel multiple unmatched (1 to 40) bets placed on a single Market.

exchange_id   = 1
bet_ids       = [16939689578, 16939689579, 169396895710]

cancel_multiple_bets = 
  bf.cancel_multiple_bets(session_token, exchange_id, bets)

Helpers

There are a bunch of helper methods to help you handle the output from the various API calls.

helpers = Betfair::Helpers.new

All Markets

When you call

all_markets = bf.get_all_markets(session_token, 2, [61420], nil, nil, nil, nil)

you get back a string of all the Australian Rules markets.

Pump it into this helper and you will get back a nice hash.

foo = helpers.all_markets(all_markets)

This returns a hash with the market_id as the key.

foo[100388290] returns

{ :market_id=>100388290, :market_name=>"Premiers 2012", :market_type=>"O", :market_status=>"ACTIVE", :event_date=>2012-03-24 16:20:00 +0800, 
  :menu_path=>"\\Australian Rules\\AFL 2012", :event_hierarchy=>"/61420/26759191/100388290", :bet_delay=>"0", :exchange_id=>2, 
  :iso3_country_code=>"AUS", :last_refresh=>2012-03-29 16:35:21 +0800, :number_of_selections=>18, :number_of_winners=>1, 
  :total_amount_matched=>193599.58, :bsp_market=>false, :turning_in_play=>false
} 

Split Markets String

This function does the same as the #all_markets method. Not sure how/why it has been duplicated, but it has so here is how it works.

all_markets = bf.get_all_markets(session_token, 2, [61420], nil, nil, nil, nil)
foo         = helpers.split_markets_string(all_markets)

The output looks a little different to the #all_markets method.

foo.first returns

{ :market_id=>100388290, :market_name=>"Premiers 2012", :market_type=>"O", :market_status=>"ACTIVE", :event_date=>2012-03-24 08:20:00 UTC, 
  :menu_path=>"\\Australian Rules\\AFL 2012", :event_heirachy=>"/61420/26759191/100388290", :bet_delay=>0, :exchange_id=>2, 
  :iso3_country_code=>"AUS", :last_refresh=>2012-03-29 09:10:12 UTC, :number_of_selections=>18, :number_of_winners=>1, 
  :total_amount_matched=>193657.0, :bsp_market=>false, :turning_in_play=>false
}

Market Info

This helper sorts out a nice hash from the

market  = bf.get_market(session_token, 2, 100388290)
foo     = helpers.market_info(market)

Which returns

{ :exchange_id=>nil, :market_type_id=>nil, :market_matched=>nil, :menu_path=>"\\AFL 2012", :market_id=>"100388290", :market_name=>"Premiers 2012", :market_type_name=>"AFL 2012" }

Prices

This helper cleans up the prices

prices  = bf.get_market_prices_compressed(session_token, 2, 100388290)
foo     = helpers.prices(prices)

Combine

Use this to combine selection_names and prices from the #market_info and #prices helpers

market  = bf.get_market(session_token, 2, 100388290)
prices  = bf.get_market_prices_compressed(session_token, 2, 100388290)    
foo     = helpers.combine(market, prices)

foo.first returns

{ :selection_id=>39983, :selection_name=>"Collingwood Magpies", :market_id=>100388290, :market_type_id=>61420, 
  :prices_string=>"39983~0~89899.79~4.2~~~false~~~~|4.2~430.35~L~1~4.1~311.51~L~2~3.85~4.75~L~3~|4.4~155.46~B~1~4.6~230.69~B~2~5.9~100.3~B~3~", 
  :selection_matched=>89899.79, :last_back_price=>4.2, :wom=>0.6054936499440416, :b1=>4.2, :b1_available=>430.35, :b2=>4.1, :b2_available=>311.51, 
  :b3=>3.85, :b3_available=>4.75, :l1=>4.4, :l1_available=>155.46, :l2=>4.6, :l2_available=>230.69, :l3=>5.9, :l3_available=>100.3 
} 

Details

Gets the market_id/market_name and the selection_id/selection_name

market  = bf.get_market(session_token, 2, 100388290)
foo     = helpers.details(market)

Which returns

{ :market_id=>100388290, :market_type_id=>61420, 
  :selections=>[{:selection_id=>39983, :selection_name=>"Collingwood Magpies"}, {:selection_id=>244664, :selection_name=>"Hawthorn Hawks"}, 
  {:selection_id=>244663, :selection_name=>"Geelong Cats"}, {:selection_id=>244689, :selection_name=>"Carlton Blues"}, 
  {:selection_id=>210344, :selection_name=>"West Coast Eagles"}, {:selection_id=>244666, :selection_name=>"Fremantle Dockers"}, 
  {:selection_id=>244688, :selection_name=>"St Kilda Saints"}, {:selection_id=>244665, :selection_name=>"Sydney Swans"}, 
  {:selection_id=>173363, :selection_name=>"Adelaide Crows"}, {:selection_id=>210343, :selection_name=>"Essendon Bombers"}, 
  {:selection_id=>39986, :selection_name=>"Western Bulldogs"}, {:selection_id=>244667, :selection_name=>"Richmond Tigers"}, 
  {:selection_id=>2013991, :selection_name=>"North Melbourne Kangaroos"}, {:selection_id=>39987, :selection_name=>"Melbourne Demons"}, 
  {:selection_id=>39984, :selection_name=>"Brisbane Lions"}, {:selection_id=>217710, :selection_name=>"Port Adelaide Power"}, 
  {:selection_id=>4997061, :selection_name=>"Gold Coast Suns"}, {:selection_id=>5149403, :selection_name=>"Greater Western Sydney Giants"}]
}

Prices Complete

Helper to deal with the prices string from a market.

prices  = bf.get_market_prices_compressed(session_token, 2, 100388290)
foo     = helpers.prices_complete(prices)

foo.first returns

[ 39983, {:selection_id=>39983, :order_index=>0, :total_amount_matched=>89899.79, :last_price_matched=>4.2, :handicap=>0.0, 
  :reduction_factor=>0.0, :vacant=>false, :far_sp_price=>0.0, :near_sp_price=>0.0, :actual_sp_price=>0.0, :prices_string=>nil, 
  :selection_matched=>0, :last_back_price=>0, :wom=>0.5516492637413943, :b1=>4.2, :b1_available=>429.06, :b2=>4.1, :b2_available=>310.58, 
  :b3=>3.85, :b3_available=>4.75, :l1=>4.3, :l1_available=>20.0, :l2=>4.4, :l2_available=>355.0, :l3=>4.6, :l3_available=>230.0}
] 

Prices String

prices  = bf.get_market_prices_compressed(session_token, 2, 100388290)
foo     = helpers.price_string(prices, true)

{ :prices_string=>nil, :selection_matched=>0, :last_back_price=>0, :wom=>0.6054936499440416, :b1=>4.2, :b1_available=>430.35, :b2=>4.1, :b2_available=>311.51, :b3=>3.85, 
  :b3_available=>4.75, :l1=>4.4, :l1_available=>155.46, :l2=>4.6, :l2_available=>230.69, :l3=>5.9, :l3_available=>100.3
}

Set Betfair Odds

Method for dealing with calculating the Betfair increments from a price passed in.

set_betfair_odds(price, pips = 0, round_up = false, round_down = false)

helpers.set_betfair_odds(2.31, 1, false, false)

{ :price=>2.31, :prc=>2.34, :pips=>1, :increment=>0.02 }

helpers.set_betfair_odds(2.31, 1, false, true)

{ :price=>2.31, :prc=>2.32, :pips=>1, :increment=>0.02 }

helpers.set_betfair_odds(2.31, 1, false, true)

{ :price=>2.31, :prc=>2.32, :pips=>1, :increment=>0.02 }

helpers.set_betfair_odds(132, 0, false, true)

{ :price=>132.0, :prc=>130.0, :pips=>0, :increment=>10 }

Get Odds Spead

Work out the distance between a high and low spread. Useful for when the B1 and L1 are miles apart and you are trying to set a threshold on when to place a bet.

helpers.get_odds_spread(1.28, 3.43)

Extra

API Limits

Betfair API Limits

Requirements

  • savon

Requirements for testing

  • savon_spec
  • rspec
  • rake

To Do

  • Add gzip support option
  • Add em-http support as per this once this gets pulled https://github.com/rubiii/httpi/pull/40
  • The WOM of money in Helpers#price_string returns 0 if either all b1,b2,b3 or l1,l2,l3 are all 0
  • Add some error checking to the Betfair::Helper methods
  • Finish of the mash method, to return a nice hash of all market and selection info
  • Write a spec for the mashed method

Contribute

I have only added the Betfair API method calls that I need.

Feel free to fork this repo, add what you need to with the relevant RSpec tests and send me a pull request.

License

(The MIT License)

Copyright (c) 2011 Luke Byrne

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.