Get Offers Page by path and API key

GET 
/offers/pages/:path

Get Offers Page by path and API key

Request

Path Parameters

path stringrequired
URL path of the page to be returned
Example: bonus/no_deposit

Header Parameters

country-code string
ISO 3166-1 alpha-2 country code to filter and geo-target offers
Example: GB
subdivision-code string
ISO 3166-2 subdivision code to further filter offers
Example: ENG

Responses

200

Successfully retrieved offers page

application/json

Schema

Schema

id stringrequired
title stringrequired
displayTitle stringrequired
url string
description string
metaTitle stringrequired
metaDescription stringrequired

metaData

object

title string

description string

image

object

alt string

url string

type string

size int64

canonicalUrl string

ogTitle string

ogDescription string

twitterUrl string

twitterDescription string

twitterCard string

twitterImage

object

alt string

url string

type string

size int64

facebookDescription string
clickoutService stringrequired

Possible values: [LEGACY_CLICKOUT_SERVICE, OFFERS_CLICKOUT_SERVICE]

offers

object[]

Array [

id string

title string

displayTitle string

displayTitleTemplate string

bookmakerCode string

bookmaker

object

id string

name string

shortName string

displayName string

feedsCode string

productIdentifier

object

name string

code string

logoFull

object

alt string

url string

type string

size int64

logoShort

object

alt string

url string

type string

size int64

primaryColor string

secondaryColor string

relatedPageLinks url[]

review string

reviewPath string

paymentMethods string[]

Possible values: [VA, MC, MA, PP, SK, TR, CA, BT, EW, PA, PL, VE]

payoutSpeed string

geolocations

object[]

Array [

countryCode string

subdivisionCode string

]

reviewRating int32

summary string

featuredLabel stringdeprecated

featuredLabels string[]

shortTerms string

fullTerms string

termsUrl url

unit

object

unitType string

Possible values: [MONETARY, CHIPS, SPINS, SWAG, ODDS]

currencyCode string

Possible values: [EUR, GBP, USD, COP, CAD]

unitValue double

value string

offerTypes string[]

Possible values: [NO_DEPOSIT, ENHANCED_ODDS, DEPOSIT, ENHANCED_PLACES, BEST_ODDS_GUARANTEED, NON_RUNNER_NO_BET, PROMOTION]

category string

customerType string

Possible values: [NEW, ALL]

offerCta string

offerCtaTemplate string

clickOutUrl url

affiliateId string

image

object

alt string

url string

type string

size int64

geolocations

object[]

Array [

countryCode string

subdivisionCode string

]

deviceTypes string[]

Possible values: [DESKTOP, TABLET, MOBILE]

autoExpandedTermsAndConditions boolean

]

sortingStrategyType string

Possible values: [DEFAULT, RANDOM, CPA_REVENUE]

geotargeting boolean
columnHeaders string[]

bookiesTrustData

object[]

Array [

title string

text string

image string

alt string

type string

Possible values: [TEXT, ICON_TEXT]

geolocations

object[]

Array [

countryCode string

subdivisionCode string

]

]

positionOverrides

object[]

Array [

offerId string

position int32

startDate date-time

endDate date-time

]

presentationConfig

object

bookieRating boolean

paymentMethods boolean

payoutSpeed boolean

offerTypeFiltering boolean

forceTermsAccordionsOpen boolean

isSummaryVisible boolean

evergreenContent

object

id stringrequired

orderedListId stringrequired

title stringrequired

displayTitle stringrequired

listedContent

object[]

required

Array [

id stringrequired

title stringrequired

content stringrequired

]

Example (from schema)

{
  "id": "string",
  "title": "string",
  "displayTitle": "string",
  "url": "string",
  "description": "string",
  "metaTitle": "string",
  "metaDescription": "string",
  "metaData": {
    "title": "string",
    "description": "string",
    "image": {
      "alt": "string",
      "url": "string",
      "type": "string",
      "size": 0
    },
    "canonicalUrl": "string",
    "ogTitle": "string",
    "ogDescription": "string",
    "twitterUrl": "string",
    "twitterDescription": "string",
    "twitterCard": "string",
    "twitterImage": {
      "alt": "string",
      "url": "string",
      "type": "string",
      "size": 0
    },
    "facebookDescription": "string"
  },
  "clickoutService": "LEGACY_CLICKOUT_SERVICE",
  "offers": [
    {
      "id": "string",
      "title": "string",
      "displayTitle": "string",
      "displayTitleTemplate": "string",
      "bookmakerCode": "string",
      "bookmaker": {
        "id": "string",
        "name": "string",
        "shortName": "string",
        "displayName": "string",
        "feedsCode": "string",
        "productIdentifier": {
          "name": "string",
          "code": "string"
        },
        "logoFull": {
          "alt": "string",
          "url": "string",
          "type": "string",
          "size": 0
        },
        "logoShort": {
          "alt": "string",
          "url": "string",
          "type": "string",
          "size": 0
        },
        "primaryColor": "string",
        "secondaryColor": "string",
        "relatedPageLinks": [
          "string"
        ],
        "review": "string",
        "reviewPath": "string",
        "paymentMethods": [
          "VA"
        ],
        "payoutSpeed": "string",
        "geolocations": [
          {
            "countryCode": "string",
            "subdivisionCode": "string"
          }
        ],
        "reviewRating": 0
      },
      "summary": "string",
      "featuredLabels": [
        "string"
      ],
      "shortTerms": "string",
      "fullTerms": "string",
      "termsUrl": "string",
      "unit": {
        "unitType": "MONETARY",
        "currencyCode": "EUR",
        "unitValue": 0,
        "value": "string"
      },
      "offerTypes": [
        "NO_DEPOSIT"
      ],
      "category": "string",
      "customerType": "NEW",
      "offerCta": "string",
      "offerCtaTemplate": "string",
      "clickOutUrl": "string",
      "affiliateId": "string",
      "image": {
        "alt": "string",
        "url": "string",
        "type": "string",
        "size": 0
      },
      "geolocations": [
        {
          "countryCode": "string",
          "subdivisionCode": "string"
        }
      ],
      "deviceTypes": [
        "DESKTOP"
      ],
      "autoExpandedTermsAndConditions": true
    }
  ],
  "sortingStrategyType": "DEFAULT",
  "geotargeting": true,
  "columnHeaders": [
    "string"
  ],
  "bookiesTrustData": [
    {
      "title": "string",
      "text": "string",
      "image": "string",
      "alt": "string",
      "type": "TEXT",
      "geolocations": [
        {
          "countryCode": "string",
          "subdivisionCode": "string"
        }
      ]
    }
  ],
  "positionOverrides": [
    {
      "offerId": "string",
      "position": 0,
      "startDate": "2024-07-29T15:51:28.071Z",
      "endDate": "2024-07-29T15:51:28.071Z"
    }
  ],
  "presentationConfig": {
    "bookieRating": true,
    "paymentMethods": true,
    "payoutSpeed": true,
    "offerTypeFiltering": true,
    "forceTermsAccordionsOpen": true,
    "isSummaryVisible": true
  },
  "evergreenContent": {
    "id": "string",
    "orderedListId": "string",
    "title": "string",
    "displayTitle": "string",
    "listedContent": [
      {
        "id": "string",
        "title": "string",
        "content": "string"
      }
    ]
  }
}

Success

{
  "id": "7BYUzmPgjGHU9gMnmpZbai",
  "title": "US - Mobile Casino",
  "displayTitle": "BEST MOBILE CASINOS MAY 2024",
  "url": "/casino/mobile-casinos",
  "metaTitle": "Mobile Casinos For Real Money | Best Mobile Casinos April 2024",
  "metaDescription": "Claim the best casino bonuses and play at mobile casinos for real money!",
  "clickoutService": "LEGACY_CLICKOUT_SERVICE",
  "offers": [
    {
      "id": "5tTotHVzX4pag7DG8dIe4l",
      "title": "FanDuel Welcome Offer",
      "displayTitle": "Bet $5 on any NBA Moneyline Get $150 in Bonus Bets if they win",
      "bookmakerCode": "U1",
      "customerType": "NEW",
      "offerCta": "Claim Now",
      "offerTypes": [
        "DEPOSIT",
        "PROMOTION"
      ]
    }
  ],
  "columnHeaders": [
    "Casino",
    "Welcome Bonus",
    "Visit Site"
  ]
}

404

Internal error

application/json

Schema

Schema

timestamp string
status int32
error string
message string
path string

queryParams

object

property name*

string[]

Array [

string

]

Example (from schema)

{
  "timestamp": "string",
  "status": 0,
  "error": "string",
  "message": "string",
  "path": "string",
  "queryParams": {}
}

NotFound

{
  "timestamp": "2024-05-02T15:23:03.273401495",
  "status": 404,
  "error": "NOT_FOUND",
  "message": "Offers not found for productIdentifierCode and path: xyz and /poker",
  "path": "uri=/v1/offers/pages/poker",
  "queryParams": {}
}

Loading...