All paths are relative to https://api.trafficox.com/api and need the
Api-Key header — see API authentication. :id
accepts the numeric ID shown in the platform.
Account
| Method | Path | What it does |
|---|---|---|
| GET | /v1/me | Your account: email, username and total balance |
| GET | /v1/balance_stats | What you earned and spent per day. Takes date_start and date_end; up to 60 days at a time, no more than 90 days back |
| GET | /v1/filters | The values you can use in filters: countries, categories, operating systems, browsers and platforms |
Domain filters
| Method | Path | What it does |
|---|---|---|
| GET | /v1/domain_filters | Your lists. Takes page, length (up to 20), search and list_type |
| POST | /v1/domain_filters | Create a list. Body: {"domain_filter":{"name":"…","list_type":"blacklist","domains":["example.com"]}} |
| GET | /v1/domain_filters/:id | One list |
| PUT, PATCH | /v1/domain_filters/:id | Update a list |
| POST | /v1/domain_filters/:id/add_domains | Add domains. Body: {"domains":["a.com","b.com"]}, up to 15,000 |
| POST | /v1/domain_filters/:id/remove_domains | Remove domains, same body |
Popunder buy orders
| Method | Path | What it does |
|---|---|---|
| GET | /v1/popunder/buy_orders | All your popunder buy orders |
| GET | /v1/popunder/buy_orders/:id | One order with its targeting and limits |
| PATCH | /v1/popunder/buy_orders/:id | Change bid_price or attach a domain_filter_id |
| POST | /v1/popunder/buy_orders/:id/play | Resume a paused order |
| POST | /v1/popunder/buy_orders/:id/pause | Pause an order |
| POST | /v1/popunder/buy_orders/:id/stats/{breakdown} | Statistics — see breakdowns |
Sticky banner buy orders
The same endpoints under /v1/sticker/buy_orders, including PATCH, play,
pause and statistics.
Sell orders
| Method | Path | What it does |
|---|---|---|
| GET | /v1/popunder/sell_orders | All your popunder sell orders |
| GET | /v1/popunder/sell_orders/:id | One order |
| POST | /v1/popunder/sell_orders/:id/stats/{breakdown} | Statistics, including sub_ids |
| POST | /v2/sell_orders/:id/stats/sub_ids | Statistics by up to three sub IDs, with cursor paging (size, after) |
Sticky banner sell orders use /v1/sticker/sell_orders the same way; their
statistics have no domain breakdown.
RTB feeds
| Method | Path | What it does |
|---|---|---|
| GET | /v1/popunder/rtb_feeds | Your popunder RTB feeds |
| GET | /v1/popunder/rtb_feeds/:id | One feed |
| POST | /v1/popunder/rtb_feeds/:id/play | Resume a feed |
| POST | /v1/popunder/rtb_feeds/:id/pause | Pause a feed |
| POST | /v1/popunder/rtb_feeds/:id/stats/{breakdown} | Feed statistics |
Sticky banner feeds use /v1/sticker/rtb_feeds.
RTB statistics for the whole account
| Method | Path | What it does |
|---|---|---|
| POST | /v1/rtb_stats/{breakdown} | Popunder RTB statistics across all your feeds |
| POST | /v1/sticker/rtb_stats/{breakdown} | The same for sticky banners |
RTB statistics take from and size (default 10) for paging and cover up to
60 days at a time, no more than 90 days back.