Income items

The income items endpoint provides an estimate for each of the probes or anchors that generate credit income for you.

Note that you will have to replace the key search parameter in the URI with the UUID of a key assigned the right permissions for this operation.

GET /api/v2/credits/income-items/?key=YOUR_KEY_WITH_INCOME_ITEMS_READ_PERMISSION

The items are grouped according to their type, and include links to the relevant locations in the probes API.

• Hosted probes: These are probes that are hosted by you. You receive credits for the time that the probe is connected, and extra credits for results that the probe generates
• Sponsored probes: These are probes that are sponsored by you. You receive credits for uptime of the probe
• Ambassador probes: These are probes that you have distributed as a RIPE Atlas ambassador. You receive a (smaller) amount of credits for uptime of the probe
• Hosted anchors: These are RIPE Atlas anchors that are hosted by you. You receive a large number of credits for the time that the anchor is connected, and extra credits for results that the anchor generates
• Sponsored anchors: These are RIPE Atlas anchors that are sponsored by you. You receive a large number of credits for the time that the anchor is connected

Note: the daily income estimates are based on the assumption that your probe will be connected for an entire 24-hour period, and where relevant that the probe or anchor will generate as many results today as it did yesterday.