show earnings

Retrieves the earnings history for a specified time range and optionally per machine.

CLI Usage: vastai show earnings [options]

GET /api/v0/users/{user_id}/machine-earnings/

show earnings

cURL

curl --request GET \
  --url https://console.vast.ai/api/v0/users/{user_id}/machine-earnings/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://console.vast.ai/api/v0/users/{user_id}/machine-earnings/"

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

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

print(response.text)

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

fetch('https://console.vast.ai/api/v0/users/{user_id}/machine-earnings/', 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://console.vast.ai/api/v0/users/{user_id}/machine-earnings/",
  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://console.vast.ai/api/v0/users/{user_id}/machine-earnings/"

	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://console.vast.ai/api/v0/users/{user_id}/machine-earnings/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.vast.ai/api/v0/users/{user_id}/machine-earnings/")

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

{
  "summary": {
    "total_gpu": 123,
    "total_stor": 123,
    "total_bwu": 123,
    "total_bwd": 123
  },
  "username": "<string>",
  "email": "<string>",
  "fullname": "<string>",
  "address1": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "zip": "<string>",
  "country": "<string>",
  "taxinfo": "<string>",
  "current": {
    "balance": 123,
    "service_fee": 123,
    "total": 123,
    "credit": 123
  },
  "per_machine": [
    {
      "machine_id": 123,
      "gpu_earn": 123,
      "sto_earn": 123,
      "bwu_earn": 123,
      "bwd_earn": 123
    }
  ],
  "per_day": [
    {
      "day": 123,
      "gpu_earn": 123,
      "sto_earn": 123,
      "bwu_earn": 123,
      "bwd_earn": 123
    }
  ]
}

{
  "success": false,
  "error": "<string>",
  "msg": "<string>"
}

{
  "detail": "API requests too frequent endpoint threshold=2.0"
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Path Parameters

user_id · integer · required

The ID of the user.

Query Parameters

sday · integer

Start day for the earnings report.

eday · integer

End day for the earnings report.

machid · integer

Optional machine ID to filter earnings.

last_days · integer

Number of days to look back from today.

Response

200

application/json

Success response

summary · object

Show child attributes

username · string

email · string

fullname · string

address1 · string

address2 · string

city · string

zip · string

country · string

taxinfo · string

current · object

Show child attributes

per_machine · object[]

Show child attributes

per_day · object[]

Show child attributes