Authentication
This endpoint requires authentication. Include your bearer token in the Authorization header.Query Parameters
| Parameter | Type | In | Required | Description |
|---|---|---|---|---|
artists | string | query | ❌ | Filters the data by artist. Comma-separated list of artist IDs |
user | string | query | ❌ | Filters the data by user. Specifies a user ID |
country | string | query | ❌ | Filter the data by country. Comma-separated values |
dsp | string | query | ❌ | Filters by DSP (Digital Service Provider). Comma-separated values |
start | string | query | ❌ | Start date of the period (YYYY-MM-DD format) |
end | string | query | ❌ | End date of the period (YYYY-MM-DD format) |
type | string | query | ❌ | Filters by sale type. Comma-separated values |
upc | string | query | ❌ | Filters by UPC (Universal Product Code). Comma-separated values |
isrc | string | query | ❌ | Filters by ISRC (International Standard Recording Code). Comma-separated values |
periodFilterType | string | query | ❌ | Filters by either ‘accounting’ or ‘sale’ period |
Responses
✅ 200 - Successfully retrieved royalty data by aggregator
⚠️ 401 - Unauthorized
❌ 500 - Internal Server Error
Tags
RoyaltiesAuthorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Query Parameters
Filters the data by artist. Comma-separated list of artist IDs
Filters the data by user. Specifies a user ID
Filter the data by country. Comma-separated values
Filters by DSP (Digital Service Provider). Comma-separated values
Start date of the period (YYYY-MM-DD format)
End date of the period (YYYY-MM-DD format)
Filters by sale type. Comma-separated values
Filters by UPC (Universal Product Code). Comma-separated values
Filters by ISRC (International Standard Recording Code). Comma-separated values
Filters by either 'accounting' or 'sale' period
Available options:
accounting, sale