Geo Rights

Holds translated data matching the affiliate live game rights based on either of the supplied parameters:

`country abbreviation` and `postal code`
`latitude and longitude`
`dma`

Fields

Name Default Field Type Description
id string unique identifier
countryAbbr String Two or three letter abbreviation of the country of interest. Ex US
zipCode String US Postal Code matching requested used used in query.
latLng String The latitude and longitude in degrees used in query. Ex 40.714224,-73.961452
callSigns * list Affiliate call sign (a.k.a call letters) associated with the zipCode
redzoneAvailable * boolean Indicating that Redzone is available or not for given geo information
redzoneRoles * list Available Redzone roles for given geo information
whitelist * list<RegionalGame> Game available for the current week to the affiliates
blacklist * list<RegionalGame> Game not available for the current week to the affiliates

RegionalGame

Name Default Field Type Description
gameId * String Game unique identifier
affiliate * String PreSeason: network name for National or NFLN games, DMA for rest of games
Regular Season : Affiliate call sign (a.k.a call letters) associated with the zipCode

Usage

Reading

Responses may not include the zipCode property for requests of countries outside the US.

GET /v1/geo/{countryAbbr}/{zipCode}

Returns a Regional Game specified by {countryAbbr} and {zipCode} for the /currentWeek.

Request Header

Name required/optional description
NFL_GEO_COUNTRY optional Use header's value if presented. Otherwise use {countryAbbr} in request path. Use ISO-3166-alpha-2 for country code

Field Selection and Query are not supported.

Example: Request:

GET /v1/geo/US/83001

Response:

{
  "countryAbbr": "US",
  "zipCode": "83001",
  "callSigns": [
    "KIDK",
    "KXPI"
  ],
  "redzoneAvailable": true,
  "redzoneRoles": [
    "VZ_REDZONE",
    "SEASON_TICKET_HOLDER",
    "MVPD_REDZONE"
  ],
  "whitelist": [
    {
      "gameId": "10012014-0907-041f-46bb-58a43d382c6a",
      "affiliate": "KIDK"
    },
    {
      "gameId": "10012014-0907-008e-ada3-73c527440e56",
      "affiliate": "KXPI"
    },
    {
      "gameId": "10012014-0907-10bc-930e-53e02632bd76",
      "affiliate": "KXPI"
    }
  ],
  "blacklist": [
    {
      "gameId": "10012014-0907-07a8-62b0-3a3e63f8d19a",
      "affiliate": "KIDK"
    }
  ]
}

GET /v1/geo/{latitudeLongitude}

Returns a Regional Game specified by {latitudeLongitude} for the /currentWeek.

Request Header

Name required/optional description
NFL_GEO_COUNTRY optional Use header's value if presented. Otherwise use "US" as default value. Use ISO-3166-alpha-2 for country code

Field Selection and Query are not supported.

Example: Request:

GET /v1/geo/43.4756164,-110.7701901

Response:

{
  "zipCode": "83002",
  "latLong": [
    43.4756164,
    -110.7701901
  ],
  "callSigns": [
    "KIDK",
    "KXPI"
  ],
  "redzoneAvailable": true,
  "redzoneRoles": [
    "VZ_REDZONE",
    "SEASON_TICKET_HOLDER",
    "MVPD_REDZONE"
  ],  
  "whitelist": [
    {
      "gameId": "10012014-0907-041f-46bb-58a43d382c6a",
      "affiliate": "KIDK"
    },
    {
      "gameId": "10012014-0907-008e-ada3-73c527440e56",
      "affiliate": "KXPI"
    },
    {
      "gameId": "10012014-0907-10bc-930e-53e02632bd76",
      "affiliate": "KXPI"
    }
  ],
  "blacklist": [
    {
      "gameId": "10012014-0907-07a8-62b0-3a3e63f8d19a",
      "affiliate": "KIDK"
    }
  ]
}

GET /v1/geo/dma/{dma}

Returns a Regional Game specified by {dma} for the /currentWeek. You Need to use Nielsen DMA Code for {dma}.

Request Header

Name required/optional description
NFL_GEO_COUNTRY optional Use header's value if presented. Otherwise use "US" as default value. Use ISO-3166-alpha-2 for country code

Field Selection and Query are not supported.

Example: Request:

GET /v1/geo/dma/500

Response:

{
  "callSigns": [
    "KPIX",
    "KTVU"
  ],
  "redzoneAvailable": true,
  "redzoneRoles": [
    "VZ_REDZONE",
    "SEASON_TICKET_HOLDER",
    "MVPD_REDZONE"
  ],  
  "whitelist": [
    {
      "gameId": "10012014-0907-067a-c584-4c8946e1dc62",
      "affiliate": "KPIX"
    },
    {
      "gameId": "10012014-0907-008e-ada3-73c527440e56",
      "affiliate": "KTVU"
    },
    {
      "gameId": "10012014-0907-10bc-930e-53e02632bd76",
      "affiliate": "KTVU"
    }
  ],
  "blacklist": [
    {
      "gameId": "10012014-0907-067a-c584-4c8946e1dc62",
      "affiliate": "KPIX"
    },
    {
      "gameId": "10012014-0907-008e-ada3-73c527440e56",
      "affiliate": "KTVU"
    },
    {
      "gameId": "10012014-0907-10bc-930e-53e02632bd76",
      "affiliate": "KTVU"
    }
  ]
}

Pre-Season Rules:

Pre-Season has different rules for live game broadcast. The clients need to do additional entitlement check against affiliate in in whitelist object to make sure the users can watch the games even the they are in the whitelist. The affiliate will be National Game Broadcaster(ESPN, FOX, CBS, NBC) if it is national game, or it will be NFLN if the game is on NFL Network. Otherwise it will be empty string. The following are the rules based on affiliate value:

For National Game: The user with Verizon entitlement can watch National Game in the whitelist, but the one with GamePass CANNOT.

For NFLN: Both Verizon and Game Pass entitled users can watch the games in whitelist.

For other type of games: The user with Game Pass entitled can watch the game in whitelist, but the one with Verizon entitled CANNOT.

For example, for 2015 PRESEASON week 2 Game:

the Verizon entitled user can watch the following games:

10012015-0822-526c-0d26-53ced1d6e30a, 10012015-0820-52ad-32fe-b41d477e8789, 10012015-0821-52b7-af16-a36b08a5b0e8, 10012015-0824-51b9-2334-af62db7e89a9, 10012015-0823-531e-1095-c63e11507e2c

the Game Pass entitled user can watch the following games:

10012015-0822-56de-35ab-d831e4125616, 10012015-0823-518e-ba61-6895f5aba22e, 10012015-0822-526c-0d26-53ced1d6e30a, 10012015-0821-5164-7d67-43d664e02570, 10012015-0822-5413-5575-1a6d379d94c4, 10012015-0821-52b7-af16-a36b08a5b0e8, 10012015-0822-55d2-e9be-b12dc13eb962
10012015-0822-511d-af67-0137fb62b50e, 10012015-0820-5173-5680-931e9b54bfe3, 10012015-0823-5260-0b80-2384a6a11ea1, 10012015-0822-5317-4334-73cd6639d4d5

The games in blacklist are blocked because of DMA restrication.

Request

GET https://api.nfl.com/v1/geo/40.781811, -73.955395

Response payload :

    {
      "zipCode": "10128",
      "latLong": [
        40.781811,
        -73.955395
      ],
      "redzoneAvailable": true,
      "redzoneRoles": [
        "VZ_REDZONE",
        "SEASON_TICKET_HOLDER",
        "MVPD_REDZONE"
      ],
      "whitelist": [
        {
          "gameId": "10012015-0822-56de-35ab-d831e4125616",
          "affiliate": ""
        },
        {
          "gameId": "10012015-0823-518e-ba61-6895f5aba22e",
          "affiliate": ""
        },
        {
          "gameId": "10012015-0822-526c-0d26-53ced1d6e30a",
          "affiliate": "NFLN"
        },
        {
          "gameId": "10012015-0820-52ad-32fe-b41d477e8789",
          "affiliate": "ESPN"
        },
        {
          "gameId": "10012015-0822-5413-5575-1a6d379d94c4",
          "affiliate": ""
        },
        {
          "gameId": "10012015-0822-58ac-1450-3242be918995",
          "affiliate": "NFLN"
        },
        {
          "gameId": "10012015-0821-52b7-af16-a36b08a5b0e8",
          "affiliate": "NFLN"
        },
        {
          "gameId": "10012015-0822-511d-af67-0137fb62b50e",
          "affiliate": ""
        },
        {
          "gameId": "10012015-0820-5173-5680-931e9b54bfe3",
          "affiliate": ""
        },
        {
          "gameId": "10012015-0824-51b9-2334-af62db7e89a9",
          "affiliate": "ESPN"
        },
        {
          "gameId": "10012015-0823-5260-0b80-2384a6a11ea1",
          "affiliate": ""
        },
        {
          "gameId": "10012015-0823-531e-1095-c63e11507e2c",
          "affiliate": "FOX"
        },
        {
          "gameId": "10012015-0822-5317-4334-73cd6639d4d5",
          "affiliate": ""
        },
        {
          "gameId": "10012015-0822-5761-e9bc-1b3482a6fff9",
          "affiliate": ""
        }
      ],
      "blacklist": [
        {
          "gameId": "10012015-0821-5164-7d67-43d664e02570",
          "affiliate": ""
        },
        {
          "gameId": "10012015-0822-55d2-e9be-b12dc13eb962",
          "affiliate": ""
        }
      ]
    }