We’ve added a new response parameter—state_filter—to the Games, Games User Data, and Games International APIs, as well as the Deals and Deals User Data APIs. This field helps you determine which offers should be shown or hidden based on state availability.
Unlike query parameters, state_filter does not filter the API response itself. Instead, it provides the metadata you need to apply your own filtering logic.
Who it’s for
Partners who need finer control over offer visibility—especially those with access to offers that may be prohibited in certain states.
How it works
You’ll find the state_filter parameter within the offer data section of the API response. Each offer includes:
type – one of the following:
include– show the offer only in the listed statesexclude– hide the offer in the listed statesall– offer is available in all states (no filtering needed)
states – a list of two-letter state codes (used only when type is
includeorexclude)
Use these values to determine whether an offer should be shown in your interface:
If
type: include– display the offer only in listed states.If
type: exclude– hide the offer in those states and show it everywhere else.If
type: all– the offer is available nationwide—no state-based filtering required.
Because the API returns all offers, filtering is handled entirely on your side using your own logic and user location.