Get auto earn rewards - Payward Developer Documentation

Get auto earn rewards

curl --request GET \
  --url https://api.services.payward.com/v1/accounts/{account_id}/earn/auto/rewards \
  --header 'API-Key: <api-key>' \
  --header 'API-Nonce: <api-key>' \
  --header 'API-Sign: <api-key>'

import requests

url = "https://api.services.payward.com/v1/accounts/{account_id}/earn/auto/rewards"

headers = {
    "API-Key": "<api-key>",
    "API-Nonce": "<api-key>",
    "API-Sign": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'API-Key': '<api-key>', 'API-Nonce': '<api-key>', 'API-Sign': '<api-key>'}
};

fetch('https://api.services.payward.com/v1/accounts/{account_id}/earn/auto/rewards', 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.services.payward.com/v1/accounts/{account_id}/earn/auto/rewards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "API-Key: <api-key>",
    "API-Nonce: <api-key>",
    "API-Sign: <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.services.payward.com/v1/accounts/{account_id}/earn/auto/rewards"

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

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Nonce", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")

	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.services.payward.com/v1/accounts/{account_id}/earn/auto/rewards")
  .header("API-Key", "<api-key>")
  .header("API-Nonce", "<api-key>")
  .header("API-Sign", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.services.payward.com/v1/accounts/{account_id}/earn/auto/rewards")

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

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

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

{
  "quote_symbol": "USD",
  "quote_type": "fiat",
  "total_rewarded_in_quote": "325.62",
  "next_reward_date": "2026-06-01T00:00:00Z",
  "data": [
    {
      "symbol": "ETH",
      "type": "crypto",
      "name": "Ethereum",
      "rewarded": "0.0125",
      "rewarded_in_quote": "31.25",
      "estimated_next_reward": "0.0056",
      "estimated_next_reward_in_quote": "14.00",
      "other_assets": [
        {
          "symbol": "EIGEN",
          "type": "crypto",
          "name": "Eigenlayer",
          "rewarded": "5.0",
          "rewarded_in_quote": "12.50",
          "estimated_next_reward": "0.1",
          "estimated_next_reward_in_quote": "0.25"
        }
      ]
    }
  ]
}

GET

accounts

{account_id}

earn

auto

rewards

Get auto earn rewards

curl --request GET \
  --url https://api.services.payward.com/v1/accounts/{account_id}/earn/auto/rewards \
  --header 'API-Key: <api-key>' \
  --header 'API-Nonce: <api-key>' \
  --header 'API-Sign: <api-key>'

import requests

url = "https://api.services.payward.com/v1/accounts/{account_id}/earn/auto/rewards"

headers = {
    "API-Key": "<api-key>",
    "API-Nonce": "<api-key>",
    "API-Sign": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'API-Key': '<api-key>', 'API-Nonce': '<api-key>', 'API-Sign': '<api-key>'}
};

fetch('https://api.services.payward.com/v1/accounts/{account_id}/earn/auto/rewards', 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.services.payward.com/v1/accounts/{account_id}/earn/auto/rewards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "API-Key: <api-key>",
    "API-Nonce: <api-key>",
    "API-Sign: <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.services.payward.com/v1/accounts/{account_id}/earn/auto/rewards"

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

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Nonce", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")

	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.services.payward.com/v1/accounts/{account_id}/earn/auto/rewards")
  .header("API-Key", "<api-key>")
  .header("API-Nonce", "<api-key>")
  .header("API-Sign", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.services.payward.com/v1/accounts/{account_id}/earn/auto/rewards")

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

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

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

{
  "quote_symbol": "USD",
  "quote_type": "fiat",
  "total_rewarded_in_quote": "325.62",
  "next_reward_date": "2026-06-01T00:00:00Z",
  "data": [
    {
      "symbol": "ETH",
      "type": "crypto",
      "name": "Ethereum",
      "rewarded": "0.0125",
      "rewarded_in_quote": "31.25",
      "estimated_next_reward": "0.0056",
      "estimated_next_reward_in_quote": "14.00",
      "other_assets": [
        {
          "symbol": "EIGEN",
          "type": "crypto",
          "name": "Eigenlayer",
          "rewarded": "5.0",
          "rewarded_in_quote": "12.50",
          "estimated_next_reward": "0.1",
          "estimated_next_reward_in_quote": "0.25"
        }
      ]
    }
  ]
}

Authorizations

API-Key

string

header

required

Your public API key. Identifies the partner making the request.

API-Nonce

string

header

required

Monotonically increasing nonce included in the request signature.

API-Sign

string

header

required

HMAC signature over the request, computed with your private key.

Path Parameters

account_id

string

required

ID of the account to retrieve rewards for. Refers to one of the accounts held by the user the request is acting on behalf of.

Pattern: ^[A-Z0-9]{16}$

Query Parameters

quote_symbol

string

Ticker symbol of the quote asset for converted amounts (e.g. "USD", "EUR"). Defaults to "USD".

Maximum string length: 10

quote_type

string

Type of the quote asset. Only "fiat" is supported. Defaults to "fiat".

Maximum string length: 16

page_token

string

Opaque page token returned by a previous response. Omit to start from the beginning.

Required string length: 1 - 256

page_size

integer<int32>

default:20

Maximum number of results to return.

Required range: 1 <= x <= 25

Response

Successful response

data

object[]

required

Per-asset reward entries for the requested page.

Show child attributes

total_rewarded_in_quote

string

Sum of all per-asset rewarded_in_quote values expressed in the quote currency.

next_reward_date

string<date-time>

RFC 3339 timestamp.

next_page_token

string

Opaque token for the next page of results. Absent if there are no more results.

Required string length: 1 - 256

quote_symbol

string

Symbol of the quote asset used for converted amounts (e.g. "USD", "EUR").

quote_type

string

Type of the quote asset (e.g. "fiat").

Get account auto earn assets Get auto earn assets

⌘I