GET /api/v1/hosts/earnings

Operation: getHostEarnings.

Earnings (host owner): earned, disputed, payable, requested, settled; gross vs snapshotted fee; no utilization guess

Endpoint

GET https://amplerun-api.spiry.org/api/v1/hosts/earnings

Authentication

Use the credential and scope required by this operation. For programmatic renter/host calls: Authorization: Bearer $AMPLERUN_API_KEY. A host-agent signature or other specialized proof is required where the description specifies it.

Parameters

Name	Location	Presence	Type	Description
asset	query	Optional	“USDC” / “USDT”

Responses

200

Earnings breakdown.

application/json

Field	Type	Presence	Description
earned_micro	MicroAmount	Required
disputed_micro	MicroAmount	Required
payable_micro	MicroAmount	Required
requested_micro	MicroAmount	Required
settled_micro	MicroAmount	Required
gross_micro	MicroAmount	Required
fee_micro	MicroAmount	Required
fee_bps	integer	Required
window_days	integer	Required
from	Rfc3339Utc	Required
to	Rfc3339Utc	Required
days	array of object	Required

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "earned_micro",
    "disputed_micro",
    "payable_micro",
    "requested_micro",
    "settled_micro",
    "gross_micro",
    "fee_micro",
    "fee_bps",
    "window_days",
    "from",
    "to",
    "days"
  ],
  "properties": {
    "earned_micro": {
      "$ref": "#/components/schemas/MicroAmount"
    },
    "disputed_micro": {
      "$ref": "#/components/schemas/MicroAmount"
    },
    "payable_micro": {
      "$ref": "#/components/schemas/MicroAmount"
    },
    "requested_micro": {
      "$ref": "#/components/schemas/MicroAmount"
    },
    "settled_micro": {
      "$ref": "#/components/schemas/MicroAmount"
    },
    "gross_micro": {
      "$ref": "#/components/schemas/MicroAmount"
    },
    "fee_micro": {
      "$ref": "#/components/schemas/MicroAmount"
    },
    "fee_bps": {
      "type": "integer"
    },
    "window_days": {
      "type": "integer"
    },
    "from": {
      "$ref": "#/components/schemas/Rfc3339Utc"
    },
    "to": {
      "$ref": "#/components/schemas/Rfc3339Utc"
    },
    "days": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "day",
          "earned_micro",
          "fee_micro",
          "paid_micro",
          "rental_count"
        ],
        "properties": {
          "day": {
            "type": "string",
            "description": "UTC calendar day, YYYY-MM-DD"
          },
          "earned_micro": {
            "type": "string",
            "pattern": "^-?(0|[1-9][0-9]*)$"
          },
          "fee_micro": {
            "type": "string",
            "pattern": "^-?(0|[1-9][0-9]*)$"
          },
          "paid_micro": {
            "$ref": "#/components/schemas/MicroAmount"
          },
          "rental_count": {
            "type": "integer"
          }
        }
      }
    }
  }
}

default

Error envelope. 401 unauthenticated, 403/404 forbidden, 409 conflict, 422 invalid input, 429 rate limited (code UNAVAILABLE, retryable:true, no Retry-After header), 503 unavailable money/provider state with retryable:true.

application/json

Field	Type	Presence	Description
error	object	Required

{
  "$ref": "#/components/schemas/ErrorEnvelope"
}

Static request outline

Replace path/query placeholders and provide the required JSON body, headers and credential from the sections above. This is a request outline, not a command that chooses an amount or starts a rental for you.

curl --request GET 'https://amplerun-api.spiry.org/api/v1/hosts/earnings' \
  --header "Authorization: Bearer $AMPLERUN_API_KEY"

Schema definitions · Download OpenAPI · Authentication · Errors and recovery