Data Pools

List data pools

Retrieves every active data pool in your organization, with how much of each is left.

A pool covers one region. Numbers in that region draw on the pool as they use data, and stop when it is exhausted — so remainingGB is the figure to watch if you resell the pool and decide when to top up or throttle a customer.

Consumption figures lag the network by the same delay as the usage feed, up to about 16 hours in some markets, so remainingGB does not yet count usage the network has not reported.

Scope: pools:read.

get/v1/data-pools

Request

  • Base URL
    https://api.telgea.com
  • Auth
    API key in header x-api-key

Response

Successfully retrieved the active data pools and their balances.

Example response

{
  "pools": [
    {
      "poolId": "6b9a0c74-51d2-4e83-9f16-2a7c8d0e5b34",
      "regionId": "eu-zone-1",
      "regionName": "Europe",
      "totalAmountGB": 500,
      "consumedGB": 312.4,
      "remainingGB": 187.6,
      "expirationDate": "2026-12-31"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.