Skip to main content
GET
/
revenue
/
summary
Get Revenue Summary
curl --request GET \
  --url https://api.royalti.io/revenue/summary \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/revenue/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.royalti.io/revenue/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.royalti.io/revenue/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.royalti.io/revenue/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.royalti.io/revenue/summary")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/revenue/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
{
  "message": "success",
  "summary": {
    "total": 142,
    "byStatus": {
      "pending": 23,
      "approved": 45,
      "completed": 74
    },
    "byType": {
      "streaming": 50,
      "sales": 30,
      "licensing": 20
    },
    "amountsByType": {
      "streaming": 30000,
      "sales": 15000,
      "licensing": 5000,
      "sync": 3000,
      "merchandise": 2500,
      "live_performance": 1820.5,
      "other": 1000
    },
    "totalAmount": 58320.5,
    "totalAmountUSD": 58320.5
  }
}
{
"status": "error",
"message": "Unauthorized"
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

Authorization:
  • Required role: user or higher
Query Parameters:
ParameterTypeDescription
startDate (Optional)stringFilter revenues from this date (inclusive)
endDate (Optional)stringFilter revenues to this date (inclusive)
currency (Optional)stringFilter by currency code
type (Optional)stringFilter by revenue type
status (Optional)stringFilter by status (pending, approved, completed)

Code Examples

const response = await fetch('https://api.royalti.io/revenue/summary', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

const data = await response.json();
console.log(data);
import requests

response = requests.get(
  'https://api.royalti.io/revenue/summary',
  headers={
    'Authorization': f'Bearer {token}'
  },
)

data = response.json()
print(data)
curl -X GET https://api.royalti.io/revenue/summary \
  -H "Authorization: Bearer YOUR_TOKEN" \

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

startDate
string<date>

Filter revenues from this date (inclusive)

endDate
string<date>

Filter revenues to this date (inclusive)

currency
string

Filter by currency code (e.g., USD, EUR)

type
enum<string>

Filter by revenue type

Available options:
streaming,
sales,
licensing,
sync,
merchandise,
live_performance,
other
status
enum<string>

Filter by revenue status

Available options:
pending,
approved,
completed

Response

Success

message
string
Example:

"success"

summary
object