GetMarketplaceSaleCount

Get Marketplace Sale Count

Allows to get Marketplace Sale count based on filters.

Request

URL: /v1/marketplace/sales/count

Method: GET

Path Parameters: None

Query Parameters:

Parameter	Type	Description	Requirement Type
phrase	string	Case-insensitive phrase to filter out sales by searching the associated song's title and artist's stage name. If the parameter is missing, defaults to no filtering out.	Optional
ids	string list	Comma-separated list of sale UUIDs for filtering results. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified.	Optional
songIds	string list	Comma-separated list of song UUIDs for filtering results. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified.	Optional
artistIds	string list	Comma-separated list of song artist UUIDs for filtering results. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified.	Optional
addresses	string list	Comma-separated list of Cardano stake or payment addresses for filtering results. The stake-key is extracted from each address and is used to compare against the stake-key of the ownerAddress given when the Sale was created. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified.	Optional
genres	string list	Comma-separated list of song genres for filtering results. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified.	Optional
moods	string list	Comma-separated list of song moods for filtering results. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified.	Optional
saleStatuses	string list	Comma-separated list of sale statuses for filtering results. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified.	Optional
olderThan	string	ISO-8601 formated oldest (maximum) timestamp to filter-out results. If missing, defaults to no filtering out.	Optional
newerThan	string	ISO-8601 formated newest (minimum) timestamp to filter-out results. If missing, defaults to no filtering out.	Optional

Headers:

Accept: application/json

g-recaptcha-platform: {Web|Android|iOS}

g-recaptcha-token: {reCAPTCHA Token for "get_sale_count" action}

✅ Success Response

Code: 200 OK

Headers:

Content-Type: application/json

Content:

Field	Type	Description	Condition
count	long	Song count.	Always

Content example:

{
    "count": 300
}

❌ Error Responses

1. Forbidden

Code: 403 FORBIDDEN

Condition: If reCAPTCHA fails.

Headers:

Content-Type: application/json

Content example:

{
    "code": 403,
    "description": "Forbidden",
    "cause": "Recaptcha failed"
}

2. Unprocessable Entity

Code: 422 UNPROCESSABLE ENTITY

Condition: If any of the UUID query parameters is malformed.

Headers:

Content-Type: application/json

Content example:

{
    "code": 422,
    "description": "Unprocessable Entity",
    "cause": "Invalid UUID string: 123456789"
}

See Also

Get Marketplace Sales

Get Marketplace Sale