-
Notifications
You must be signed in to change notification settings - Fork 4
GetMarketplaceArtists
Walter Lara edited this page Jul 16, 2024
·
2 revisions
Allows to get Marketplace Artists. This endpoint supports pagination and filtering.
URL: /v1/marketplace/artists
Method: GET
Path Parameters: None
Query Parameters:
Parameter | Type | Description | Requirement Type |
---|---|---|---|
offset | integer | Start offset of paginated results to retrieve. Default is 0. | Optional |
limit | integer | Maximum number of paginated results to retrieve. Default is 25. | Optional |
sortOrder | string | Sort order of the results based on createdAt field. Valid values are desc (newest first) and asc (oldest first). Default is asc. |
Optional |
ids | string list | Comma-separated list of Artist UUID's for filtering results. 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 Artist genres 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_artists" action}
Code: 200 OK
Headers:
Content-Type: application/json
Content:
Field | Type | Description | Condition |
---|---|---|---|
id | string | UUID of the Artist. | Always |
createdAt | string | Date and time when the Artist was created (ISO-8601 format). | Always |
name | string | Stage name of the Artist. | Only if available |
genre | string | Artist genre. | Only if available |
location | string | Artist location. | Only if available |
biography | string | Artist biography. | Only if available |
pictureUrl | string | Valid URL of Artist picture image file. | Only if available |
websiteUrl | string | Valid URL of Artist personal website. | Only if available |
twitterUrl | string | Valid URL of Artist Twitter account. | Only if available |
instagramUrl | string | Valid URL of Artist Instagram account. | Only if available |
spotifyProfile | string | Spotify artist profile URI. E.g. spotify:artist:xyz for artist link https://open.spotify.com/artist/xyz include. |
Only if available |
soundCloudProfile | string | SoundCloud artist profile permalink. E,g. xyz for artist link https://soundcloud.com/xyz . |
Only if available |
appleMusicProfile | string | Apple Music artist profile ID. E,g. xyz for artist link https://music.apple.com/abcd/efg/xyz . |
Only if available |
releasedSongCount | integer | Number of songs released in NEWM Studio by the Artist. | Always |
marketplaceSongCount | integer | Number of songs in NEWM Marketplace by the Artist. | Always |
Content example:
[
{
"id": "7bd2862f-8deb-4814-8943-156d9dab80dd",
"createdAt": "2022-04-22T20:47:55.738918",
"name": "John Doe",
"genre": "Pop",
"location": "USA",
"biography": "John is a leading Pop Music Artist",
"pictureUrl": "https://example.com/john-doe.png",
"websiteUrl": "https://john-doe.com",
"twitterUrl": "https://twitter.com/john-doe",
"instagramUrl": "https://instagram.com/john-doe",
"spotifyProfile": "spotify:artist:john.doe"
"soundCloudProfile": "john.doe",
"appleMusicProfile": "john.doe",
"releasedSongCount": 14,
"marketplaceSongCount": 9
},
{
"id": "46550a07-31f3-48b1-8e12-b7c2a9fcde93",
"createdAt": "2024-05-11T10:40:40.588936",
"name": "Jane Doe",
"genre": "R&B",
"location": "UK",
"biography": "JaneJohn is a leading R&B Music Artist",
"pictureUrl": "https://example.com/jane-doe.png",
"websiteUrl": "https://jane-doe.com",
"twitterUrl": "https://twitter.com/jane-doe",
"instagramUrl": "https://instagram.com/jane-doe",
"spotifyProfile": "spotify:artist:jane.doe"
"soundCloudProfile": "jane.doe",
"appleMusicProfile": "jane.doe",
"releasedSongCount": 18,
"marketplaceSongCount": 15
}
]
Code: 403 FORBIDDEN
Condition: If reCAPTCHA fails.
Headers:
Content-Type: application/json
Content example:
{
"code": 403,
"description": "Forbidden",
"cause": "Recaptcha failed"
}
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"
}