Device Summary

The Device Summary endpoint provides detailed information on a specific device. This allows you to view the device’s status, aspects of connectivity, compute hours served, earnings and more.

GET /v1/io-explorer/devices/{device_id}/summary

Device Summary

cURL

curl --request GET \
  --url https://api.io.solutions/v1/io-explorer/devices/{device_id}/summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.io.solutions/v1/io-explorer/devices/{device_id}/summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.io.solutions/v1/io-explorer/devices/{device_id}/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.io.solutions/v1/io-explorer/devices/{device_id}/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.io.solutions/v1/io-explorer/devices/{device_id}/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.io.solutions/v1/io-explorer/devices/{device_id}/summary")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.io.solutions/v1/io-explorer/devices/{device_id}/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "connectivity_tier": 2,
    "device_id": "c4ba4d4b-8762-4437-b82c-6f78a20a8cb5",
    "down_percentage": 22,
    "download_speed_mbps": 67,
    "downtime_by_date": {
      "2023-08-25": {
        "downtime": 58411,
        "note": "down for 0 days and 16 hours and 13 minutes"
      },
      "2023-08-31": {
        "downtime": 86400,
        "note": "down for 1 days and 0 hours and 0 minutes"
      },
      "2023-09-01": {
        "downtime": 0,
        "note": "down for 0 days and 0 hours and 0 minutes"
      }
    },
    "total_compute_hours_served": 0,
    "total_download_traffic": 0,
    "total_earnings": 0,
    "total_jobs": 0,
    "total_slashed_earning": 0,
    "total_upload_traffic": 0,
    "upload_speed_mbps": 46,
    "value": 0.1
  },
  "status": "succeeded"
}

"Not found"

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

device_id · string · required

Unique identifier for your device.

Response

200

application/json

200

data · object

Show child attributes

status · string

Example:

"succeeded"