The Feed API allows publishers to pull your offer catalogue programmatically and integrate it into their own systems. Publishers can use it to retrieve available offers, tracking links, payout information, and targeting details without logging into the Partner Platform.
Giving a publisher Feed API access
There are two ways a publisher can access the Feed API.
1) You provide the API key
Go to Publisher detail page → API tab → Feed API
Click Generate API Key
Copy the API Key and API Link
Send them to the publisher along with the Feed API documentation →
2) Publisher accesses it from the Partner Platform
Publisher logs into the Partner Platform
Goes to Settings → Feed API
Copies their API key and endpoint from there
Conditions for an offer to appear in the feed
For an offer to appear in a publisher's feed, all of the following must be true:
Offer must be active
Offer must either be public or approved on the publisher
Offer must not have reached its budget / publisher budget
Offer must be within configured time targeting range on Feed API query time
ℹ️ Offers that have reached a Soft budget will still appear in the feed — soft budgets do not remove the offer. Hard budgets remove the offer from the feed once reached. You can change this behaviour in Organization → Settings → Miscellaneous → Feed API (see Budget display settings →).
Feed API Configurator
The Feed API Configurator lets you control which offers appear in the feed. It can be configured at two levels:
Level | Where to find it |
Per publisher | Publisher detail page → Feed API tab |
Global (all publishers) | Organization → Settings → Feed API |
Configuration options
Whitelisted offers - offers you always want to show this publisher regardless of performance or age. Select specific offers to pin them to the top of the feed.
Blacklisted offers - offers you never want to show this publisher. Select specific offers to permanently exclude them.
Filters - only show offers that match all selected criteria:
Filter | How it works |
Advertiser | Only show offers from selected advertiser(s) |
Country | Only show offers targeting selected countries |
Platform | Only show offers for selected platforms (iOS, Android, Web.) |
Offer Tags | Only show offers that have the selected tags |
Reaches Store | Only show offers where Swaarm's Scan Tool has confirmed the tracking link reaches the app store. Shown with a green Hit Store indicator on the offer. Swaarm runs the Scan Tool twice per day. |
Reached Tracker | Only show offers where Swaarm's Scan Tool has confirmed the tracking link reaches a tracker. Shown with a non-empty Tracker label on the offer. |
Performance - show the publisher their top-earning approved offers in descending order of revenue over a set time period. Configure the maximum number of offers and the time window.
Example: serve up to 10 offers ranked by revenue over the past 48 hours.
Boost - show the publisher your newest offers (selected by creation date) before there's enough data to assess performance. Configure the maximum number of offers, how long to show them, and an OR condition - whichever is met first: the time window expires, OR a set number of clicks is reached.
Example: serve up to 20 new offers for up to 48 hours OR until they reach 100,000 clicks over the past 12 hours.
Exploratory - show the publisher good-performing offers from other publishers, selected by revenue over a set time period. Same OR condition applies — the offer is removed when the time window expires OR a click threshold is reached.
Example: serve up to 20 offers ranked by revenue over the past 72 hours, for up to 48 hours OR until they reach 100,000 clicks over the past 12 hours.
ℹ️ Multiple configurations - you can create multiple Feed API configurations for one publisher. They are treated as OR — an offer appearing in any configuration will be included in the feed.
ℹ️ Default values - if no number is entered for a field, the grey placeholder value shown in the field is used as the default.
ℹ️ Approved offers only - the Feed API only surfaces offers that are approved for the publisher. The configurator filters and ranks from that approved pool.
Budget display settings (global only)
These settings are in Organization → Settings → Miscellaneous → Feed API tab.
Setting | What it does |
Show Offer Budgets | All offer budgets (hourly, daily, monthly, total) will be visible in the Feed API if no offer-publisher budgets are set |
Show Soft Budgets | Soft budgets will be used instead of hard budgets when they are defined for a publisher on an offer |
⚠️ The total number of offers shown in the Feed API can be less than the sum of the limits configured across categories.
ℹ️ In case soft budgets are added to both offers and publishers or not added to either of them, then the hierarchy would be:
Offer-Publisher soft budgets
Offer-Publisher Hard budgets
Offer soft budgets
Offer Hard budgets
Debugging the feed
If a publisher reports that an offer is missing from their feed, you can inspect their feed directly using the debug URL:
https://feed.{yourdomain}.swaarm-clients.com/debug/feed?api_key={publisher_api_key}&pass={test_pub_api_key}Parameter | What to enter |
| The API key of the publisher whose feed you want to check |
| The API key of your test publisher (id2) |
The debug view shows:
An overview with the number of offers per category (Whitelisted, Performance, Boost, Exploratory)
The individual offers in each section with their IDs and statistics
ℹ️ The debug view reflects the current feed configuration. If you recently changed the configurator settings for a publisher, the debug view will show the updated feed.