title: Stats Providers short_name: Providers description: Get performance statistics for all providers in your network for the last 24 hours.

Stats Providers

This endpoint provides a summary of the performance and state of all provider devices within your network for the last 24 hours. Use this to monitor which devices are active and how much bandwidth they are contributing.

`GET /stats/providers`

Retrieves a detailed list of providers associated with the authenticated network, including uptime, transfer density, and estimated payouts.

Request

GET /stats/providers

Headers:

{
  "Host": "api.bringyour.com",
  "Authorization": "Bearer YOUR_JWT_TOKEN",
  "Accept": "application/json"
}

Response

`200 Success`

Status: 200 OK

Content-Type: application/json

{
  "created_time": "2025-01-20T12:00:00Z",
  "providers": [
    {
      "client_id": "d8e3-...",
      "connected": true,
      "connected_events_last_24h": [
        {
          "event_time": "2025-01-20T10:00:00Z",
          "connected": true
        }
      ],
      "uptime_last_24h": 23.5,
      "transfer_data_last_24h": 12.4,
      "payout_last_24h": 1.24,
      "search_interest_last_24h": 150,
      "contracts_last_24h": 45,
      "clients_last_24h": 12,
      "provide_mode": 2
    }
  ]
}

Fields

Field	Type	Description
`created_time`	`string`	ISO 8601 timestamp of when this report was generated.
`providers`	`array`	A list of provider devices and their performance metrics.
`providers[].client_id`	`string`	The unique UDID of the provider client.
`providers[].connected`	`boolean`	Indicates if the device is currently online and connected to the controller.
`providers[].uptime_last_24h`	`number`	Total number of hours the device was online in the last 24 hours.
`providers[].transfer_data_last_24h`	`number`	Total data provided in GiB during the specified period.
`providers[].payout_last_24h`	`number`	Total estimated earnings in USDC for the period.
`providers[].provide_mode`	`integer`	The current Provision Mode set for this device.

Enums

Provision Mode

Value	Title	Description
`0`	Default	Standard system behavior.
`1`	None	Device is registered but inactive.
`2`	Network	Provides to the owner's private network.
`3`	Friends & Family	Provides to trusted peer groups.
`4`	Public	Provides to the global URnetwork.
`5`	Stream	Optimized for high-throughput streaming.

Example

HTTP Request

GET /stats/providers HTTP/1.1
Host: api.bringyour.com
Authorization: Bearer YOUR_JWT_TOKEN
Accept: application/json

Successful HTTP Response

{
  "created_time": "2025-01-20T15:30:00Z",
  "providers": [
    {
      "client_id": "a1b2-c3d4-e5f6",
      "connected": true,
      "uptime_last_24h": 24.0,
      "transfer_data_last_24h": 5.2,
      "payout_last_24h": 0.52,
      "provide_mode": 4
    }
  ]
}

On this page