Skip to main content
GET
/
royalty
/
product
Get Royalties grouped by product
curl --request GET \
  --url https://api.royalti.io/royalty/product \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "id": 1,
      "Release_Name": "Greatest Hits Album",
      "displayArtist": "Main Artist",
      "type": "Album",
      "Royalty": 3256.75,
      "Count": 325000,
      "RoyaltyPercentage": 15.2,
      "CountPercentage": 10.5,
      "RatePer1K": 10.02,
      "PreviousRoyalty": 2826.15,
      "PreviousCount": 293850
    },
    {
      "id": 2,
      "Release_Name": "Latest Single",
      "displayArtist": "Artist Feature",
      "type": "Single",
      "Royalty": 1756.5,
      "Count": 175000,
      "RoyaltyPercentage": 6.8,
      "CountPercentage": 4.2,
      "RatePer1K": 10.03,
      "PreviousRoyalty": 1644.25,
      "PreviousCount": 168000
    }
  ]
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

Get Royalties grouped by product This endpoint retrieves royalty data grouped by product (albums, singles, etc.), showing revenue breakdown per product.

​
Code Examples

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

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

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
artists
string

Filters the data by artist. Comma-separated list of artist IDs

​
user
string<uuid>

Filters the data by user. Specifies a user ID

​
country
string

Filter the data by country. Comma-separated values

​
dsp
string

Filters by DSP (Digital Service Provider). Comma-separated values

​
start
string<date>

Start date of the period (YYYY-MM-DD format)

​
end
string<date>

End date of the period (YYYY-MM-DD format)

​
type
string

Filters by sale type. Comma-separated values

​
aggregator
string

Filters by aggregator. Comma-separated values

​
table_name
string

Filters by data source table name. Comma-separated values for multiple tables

​
isrc
string

Filters by ISRC (International Standard Recording Code). Comma-separated values

​
periodFilterType
enum<string>

Filters by either 'accounting' or 'sale' period

Available options:
accounting,
sale
​
page
integer

Page number for pagination

Required range: x >= 1
​
size
integer

Number of items per page

Required range: 1 <= x <= 100

Response

Successfully retrieved royalty data by product

​
results
object[]
​
totalItems
integer

Total number of items (when paginated)

​
totalPages
integer

Total number of pages (when paginated)

​
currentPage
integer

Current page number (when paginated)

​
filteredItems
integer

Number of items in current page (when paginated)