Skip to main content
GET
/
royalty
/
month
Get Royalties grouped by month (Sale period)
curl --request GET \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/royalty/month \
  --header 'Authorization: Bearer <token>'
[
  {
    "period": "2023-01",
    "totalRoyalty": 1354.25,
    "totalCount": 128000,
    "breakdown": {
      "streams": 123000,
      "downloads": 5000
    }
  },
  {
    "period": "2023-02",
    "totalRoyalty": 1556.8,
    "totalCount": 138000,
    "breakdown": {
      "streams": 133000,
      "downloads": 5000
    }
  }
]
Get Royalties grouped by month (Sale period) This endpoint retrieves royalty data grouped by sale period months, providing insights into when sales actually occurred.

​
Authentication

This endpoint requires authentication. Include your bearer token in the Authorization header.

​
Query Parameters

ParameterTypeInRequiredDescription
artistsstringquery❌Filters the data by artist. Comma-separated list of artist IDs
userstringquery❌Filters the data by user. Specifies a user ID
countrystringquery❌Filter the data by country. Comma-separated values
dspstringquery❌Filters by DSP (Digital Service Provider). Comma-separated values
startstringquery❌Start date of the period (YYYY-MM-DD format)
endstringquery❌End date of the period (YYYY-MM-DD format)
typestringquery❌Filters by sale type. Comma-separated values
aggregatorstringquery❌Filters by aggregator. Comma-separated values
upcstringquery❌Filters by UPC (Universal Product Code). Comma-separated values
isrcstringquery❌Filters by ISRC (International Standard Recording Code). Comma-separated values

​
Responses

​
✅ 200 - Successfully retrieved royalty data by sale period

​
⚠️ 401 - Unauthorized

​
❌ 500 - Internal Server Error

​
Tags

Royalties

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

​
upc
string

Filters by UPC (Universal Product Code). Comma-separated values

​
isrc
string

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

Response

Successfully retrieved royalty data by sale period

​
period
string

The time period for the data

​
totalRoyalty
number

Total royalty amount for the period

​
totalCount
integer

Total count of plays/sales for the period

​
breakdown
object

Detailed breakdown of royalty data

⌘I