API Reference
API Reference

📖 Book

The book object represents a sportsbook that you can link with. This means they have allowed you to connect with their bettor's accounts and pull bet data.

  {
    "id": "BOOK_pPg9ABaPSj2mL6qoMTKR1A",
    "name": "BetMGM",
    "abbr": "mg",
    "status": "active",
    "refreshCadenceActive": true,
    "sdkRequired": false,
    "pullBackToDate": "2022-08-19",
    "maxHistoryMonths": 24,
    "maxHistoryBets": null,
    "historyDetail": null,
    "mobileOnly": false,
    "betPlaceStatus": {
      "webBrowser": "betSlipCreation",
      "iOS": "betSlipCreation",
      "android": "unsupported"
    }
  }
SportsbookbetSyncbetPlacebetSync SDK Required?Refresh Cadence
FanDuel✅✅✅❌
DraftKings✅✅✅❌
PrizePicks✅❌✅❌
Underdog✅❌✅❌
HardRock✅❌✅❌
Sporttrade✅❌✅❌
BetRivers✅✅✅❌
ESPN BET✅✅❌✅
BetMGM✅✅❌✅
Caesars✅✅❌✅
Fliff✅❌❌✅
BetFred✅❌❌✅
Fanatics✅❌✅❌

Endpoints

book list

id (string)

A unique identifier representing the bookID. Each bookID will start with the unique character set BOOK_.

name (string)

A descriptor that represents the common name of the sportsbook.

abbr (string)

A 2 character descriptor that represents the common abbreviation of the book's common name.

status (string)

The current status of the book - one of the following:

valuedescription
activeThe sportsbook is available for new links and refreshes
inactiveThe sportsbook is currently down for maintenence
comingThe sportsbook integration is in development
unsupportedThe sportsbook integration is not currently offered

mobileOnly (boolean)

🚧

This field has been deprecated in favor of sdkRequired and `sdkSupport

refreshCadenceActive (boolean)

This field indictates if the refresh cadence is currently available for this book.

sdkRequired (boolean)

This field indicates that this book is only available to link and refresh via one of the SDKs.

sdkSupport (hash)

This field indicates the specifics of what SDKS/platforms this book is available on - see the 🔌 sdk supportfor more details. This field is null in the case that sdkRequired=false.

In order to serialize this field you must add the query parameter ?support=true to your request.

pullBackToDate(string)

For some books, there is a time-based limitation on how far bets will be synced. This field indicates the current date of that limitation.

maxHistoryMonths (int)

For some books, bets can only be synced for a specific number of months. This field indicates that limitation.

maxHistoryBets (int)

Fof some books, only a certain number of bets can be synced. This field indicates that limitation.

historyDetail (string)

This field will contain any necessary context about how much bet history can be synced, beyond the standard limitations in other fields.

oddsFeedActive (bool)

This field indicates whether 🏛️ Prices will be included for this book.

betPlaceStatus (hash)

This field indicates the specifics of what platform(s) 📖 betPlace is available on. The potential values are as follows:

unsupported

betPlace links are not supported.

inactive

betPlace links are temporarily down for maintenance.

betSlipCreation

betPlace links will fill out the betSlip on the sportsbook account automatically.

deeplink

betPlace links will deeplink to the correct page but not fill out the betslip automatically.