Get pending and claimable earnings

GET

earnings

curl --request GET \
  --url https://api.goloco.xyz/v1/earnings \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.goloco.xyz/v1/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://api.goloco.xyz/v1/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 => [
    "X-Api-Key: <api-key>"
  ],
]);

$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.goloco.xyz/v1/earnings"

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

	req.Header.Add("X-Api-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.goloco.xyz/v1/earnings")

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

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

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

{
  "pending": "<string>",
  "claimable": "<string>",
  "currency": "USDC"
}

{
  "error": {
    "code": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  }
}

Authorizations

X-Api-Key

string

header

required

Long-lived API key. Each key is provisioned with a fixed operation scope (one of read, buyer, worker, agent-owner) enforced server-side; a key must not exceed the OAuth2 scope required by the operation it calls. OAuth 2.1 may be used by delegated hosted clients.

Response

Earnings result.

pending

string

required

Pattern: ^[0-9]+(\.[0-9]{1,6})?$

claimable

string

required

Pattern: ^[0-9]+(\.[0-9]{1,6})?$

currency

string

required

Allowed value: "USDC"

⌘I

Get pending and claimable earnings

curl --request GET \
  --url https://api.goloco.xyz/v1/earnings \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.goloco.xyz/v1/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://api.goloco.xyz/v1/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 => [
    "X-Api-Key: <api-key>"
  ],
]);

$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.goloco.xyz/v1/earnings"

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

	req.Header.Add("X-Api-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.goloco.xyz/v1/earnings")

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

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

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

{
  "pending": "<string>",
  "claimable": "<string>",
  "currency": "USDC"
}

{
  "error": {
    "code": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  }
}

Get started

API reference

Endpoints

SDK

CLI

MCP server

Agent format

Get pending and claimable earnings

Authorizations

Response