-
Notifications
You must be signed in to change notification settings - Fork 5
PostUserWalletSongs
Allows to get Songs that exist in the user's Cardano Wallet. This endpoint supports pagination and filtering.
URL: /v1/cardano/songs
Method: POST
Path Parameters: None
Request Body:
From the CIP-30 connected wallet, retrieve the UTxOs using walletApi.getUtxos()
. Pass no parameters to this function to return the entire UTxO set from the wallet. This returns an array of hex strings and is used as the request body.
[
"82825820bc43a0453f0681d841798aafa11be39c49215ed9031d6dc29cb79dfeda05239a01825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb4269821a0013a9f2a1581c36a4b27112c109a41086900abc145322b16921c522e4ff8fc9dd6978a15820001bc280005c3595c1532c1059535a65ccbba1b893fd3ee58f3d2b69dae23b701a05f5e100",
"828258204dd9215f2c3900f9760793148e4ca37f22d8447e45947c27321134672fd64b2001825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb4269821a0013a9f2a1581ce65559518eef9ebc25d3bacfa3f037d3e8cf0830b879c9a3fc6d7617a15820001bc280008557b67dfef2ddfdc102ed2b6c224bc266c44dc3401ff600e165011a05f5e100",
"828258200393ec3e96eebdaeb5b0e3068b3091e96bfeb4362faeee403841f6b2ef8621ff01825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb4269821a0013a9f2a1581ce65559518eef9ebc25d3bacfa3f037d3e8cf0830b879c9a3fc6d7617a15820001bc280026c86f6bd99bb240d28a483d4c5a6ce88a1db952ef7972cc9fdc9ef1a05f5e100",
"82825820a6ff665ae54eefcfc71daf938aa557907af18b33554f2a44b5229cbea80ca41101825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb42691a109b8b7b",
"82825820d59f8f47461986c62cca38e7e791ce77c545b1551f11bf241ae64f00085545cd01825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb4269821a0013a9f2a1581ce65559518eef9ebc25d3bacfa3f037d3e8cf0830b879c9a3fc6d7617a15820001bc280006b0a3df9a1349c931a7f572602d167532474704b7d281b8750d7611a05f5e100",
"82825820d1edcdaf2cea5eb723d7ea99a8fc5042171e7c7c059ea6de422a042b0b466e9803825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb42691a1860d840",
"82825820227d6d29e52f7d2ebf292e95e59be208bba477a91d3c7c38ff1c95bcedc687f703825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb42691a1dbe22c0",
"828258200f670e19e50924827302846a9aa216a7a68445e8aeabb1d649363b137311c26701825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb4269821a0013a9f2a1581ce65559518eef9ebc25d3bacfa3f037d3e8cf0830b879c9a3fc6d7617a15820001bc28002ddaf9fd42e1996d80bb8466757ff378363133d03fed5bfe95dcbfe1a05f5e100",
"82825820821f70e6de26a8b96eb307768e8b246836cdf15dcb900ba857c5b833fdb72ca101825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb4269821a0013a9f2a1581ce65559518eef9ebc25d3bacfa3f037d3e8cf0830b879c9a3fc6d7617a15820001bc28003c52e385178e61415963fe9ef26b7ea9a8fab9e4ac1b6e1c2fa14741a05f5e100",
"8282582010bff3d1b85c55a18fb0c9c639aaf4f21866fb1b63d6a78b6208b805dc99b0ac01825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb4269821a0013a9f2a1581ce65559518eef9ebc25d3bacfa3f037d3e8cf0830b879c9a3fc6d7617a15820001bc2800318192309b6cbf9bd72ace1e75cfeecb07ff0aab89b7f51a77c75841a05f5e100",
"82825820ca6d9e3d0eb8f82d389e061e035132b2f83523bc6c571265dc4efdabddad512001825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb4269821a0013a9f2a1581ce65559518eef9ebc25d3bacfa3f037d3e8cf0830b879c9a3fc6d7617a15820001bc280031cfd72bbf3ac98873abc8abdf0ba058d23327a43292c39fb8a41db1a05e69ec0",
"82825820a3ac150f1f9f7991d81d21a1e4ea467897e9c94214878f70ef277c79e82ac3c401825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb4269821a0013a9f2a1581ce65559518eef9ebc25d3bacfa3f037d3e8cf0830b879c9a3fc6d7617a15820001bc2800089af82e9c7f11645cc671dc366a36aff905f03319d624dcc62201a1a05e69ec0",
"828258201f114195e7f557e6ea04938d91611db8b5fe2174a5ca5f544050f5790c2cee2901825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb4269821a0013a9f2a1581ce65559518eef9ebc25d3bacfa3f037d3e8cf0830b879c9a3fc6d7617a15820001bc28000f88b4548fd9422ddaac180c47c6e8c26d076a7f2ba5c6fbae9b3ea1a055d4a80",
"828258201725f7176191da6e165e56bbcd350e1dc61f35e9fa68b850745dbbc744240ba701825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb4269821a0013a9f2a1581ce65559518eef9ebc25d3bacfa3f037d3e8cf0830b879c9a3fc6d7617a15820001bc28002f7f7802b27301d6497ad5532c9ad1f536b3dfdb62ae78e5177b26a1a02faf080",
"82825820bcc2a8528b89669dcb7821da3ab192031401edea81c53c8bcdc115df995c08bd01825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb4269821a0013a9f2a1581ce65559518eef9ebc25d3bacfa3f037d3e8cf0830b879c9a3fc6d7617a15820001bc2800231cf9da9fec9977ad881794ab1dcb0770a4fda82ad7e3f2e621b711a05f5e100",
"8282582020e0a1e44989b21d354eff54e98ee30880fd596c6ccd06498253717b920e617d01825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb4269821a0013a9f2a1581ce65559518eef9ebc25d3bacfa3f037d3e8cf0830b879c9a3fc6d7617a15820001bc280037fc71d6cf5c0601c867316f0584a5cebe9288bc37a8def20688fb81a05f5e100",
"828258209814a9e199ac5fdd643c64be24cb96bb1a563f827a6b699c9349a21a2efb428101825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb4269821a0013a9f2a1581ce65559518eef9ebc25d3bacfa3f037d3e8cf0830b879c9a3fc6d7617a15820001bc2800047f5c9671760f3c337d4c0a94c0bb1ca0eb474984c30eab072388e1a05f5e100",
"82825820d5c685dc4d4be75babb17df5f056f78ae9060888a26c53a7cfacf8c87c50ad6f01825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb4269821b0000000e1073cd81a4581c698a6ea0ca99f315034072af31eaac6ec11fe8558d3f48e9775aab9da14574445249501b00000019e395113f581c70ff8215aa4bb27ca663de5958569caafc8764c21b16932e9b16b9a6a151706572736f6e616c54657374546f6b656e1a000f4240581c74946c67d2a6afbdfd9450eb9818f202ba26143f821990d7a45b515ca55144726970707932333034313935323234330151447269707079323330343139383031333701514472697070793233303431393830313837015144726970707932333034313938303138380151447269707079323330343139383031383901581c9eeb92a94656b651cbd86e2a913026cd5c511632e4b6f98a9da16367a14974657374546f6b656e1a000f4240",
"82825820857c0aff7d67b85058bc01326db1f284d9b7d8d78503535f2638641fb3079b0001825839003a5cbc099211950e25f9877ab7abd63d056d515bd64823a5de83dc2653daab1c1256d159150ed263bec087e6a6109b465b0150e9e3bb42691aeede5f94"
]
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 |
archived | boolean | Indicates if only archived songs should be included. Default is false . |
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 |
phrase | string | Case-insensitive phrase to filter out songs by searching the Song title , description , album and nftName fields as well as the Song Owner nickname if set, otherwise firstName and lastName . If the parameter is missing, defaults to no filtering out. |
Optional |
ids | string list | Comma-separated list of song UUID's for filtering results. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified. |
Optional |
ownerIds | string list | Comma-separated list of owner UUID's for filtering results. A value of "me" can be used instead of the caller's UUID. 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 to for filtering results. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified. |
Optional |
mintingStatuses | string list | Comma-separated list of song Song minting 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:
Authorization: Bearer {accessToken}
Accept: application/json
Content-Type: applicaton/json
Code: 200 OK
Headers:
Content-Type: application/json
Content:
Field | Type | Description | Condition |
---|---|---|---|
total | integer | Number of songs that exist for this user's wallet | Always |
offset | integer | Pagination offset | Always |
limit | integer | Max songs in a page | Always |
tokenAmount | integer | Number of stream tokens in the wallet | Always |
id | string | UUID of the Song. | Always |
archived | boolean | Song archive indicator. | Always |
ownerId | string | UUID of the Song owner (creator). | Always |
createdAt | string | Date and time when the Song was created (ISO-8601 format). | Always |
title | string | Song title. | Always |
genres | string array | Song genres. | Always |
moods | string array | Song moods. | Only if available |
coverArtUrl | string | Valid URL of cover art picture file. | Only if available |
lyricsUrl | string | Valid URL of song lyrics file. | Only if available |
description | string | Song description. | Only if available |
album | string | Song album. | Only if available |
track | integer | Song track. | Only if available |
language | string | Song language. | Only if available |
compositionCopyrightOwner | string | Song composition copyright owner. | Only if available |
compositionCopyrightYear | integer | Song composition copyright year. | Only if available |
phonographicCopyrightOwner | string | Song phonographic copyright owner. | Only if available |
phonographicCopyrightYear | integer | Song phonographic copyright year. | Only if available |
parentalAdvisory | string | Song parental advisory. | Only if available |
barcodeType | string | Song barcode type. Valid values are: Upc, Ean and Jan. | Only if available |
barcodeNumber | string | Song barcode number. | Only if available |
isrc | string | International Standard Recording Code (ISRC). | Only if available |
iswc | string | International Standard Musical Work Code (ISWC). | Only if available |
ipis | string array | Interested Party Information (IPIS) Numbers. | Only if available |
releaseDate | string | Song release date (ISO-8601 format) | Only if available |
publicationDate | string | Song publication date (ISO-8601 format) | Only if available |
duration | integer | Song duration in milliseconds. | Only if available |
streamUrl | string | Song streaming URL. | Only if available |
nftPolicyId | string | Song NFT Policy ID. | Only if available |
nftName | string | Song NFT Name. | Only if available |
audioEncodingStatus | string | Song audio encoding status. Valid values are: NotStarted, Started, Completed & Failed | Always |
mintingStatus | string | Song minting status. Valid values are: Undistributed, StreamTokenAgreementApproved, MintingPaymentRequested, MintingPaymentReceived, AwaitingAudioEncoding, AwaitingCollaboratorApproval, ReadyToDistribute, SubmittedForDistribution, Distributed, Declined, Pending & Minted | Always |
marketplaceStatus | string | Song marketplace status. Valid valid values are: NotSelling & Selling. | Always |
Content example:
{
"total": 2,
"offset": 0,
"limit": 25,
"songs": [
{
"tokenAmount": 100000000,
"song": {
"id": "7bd2862f-8deb-4814-8943-156d9dab80dd",
"archived": false,
"ownerId": "842f5460-76f8-41d8-add9-d043a7a381de",
"createdAt": "2022-04-22T20:47:55.738918",
"title": "Blinding Lights",
"genres": ["Synthwave", "Synthpop"],
"moods": ["Cool", "Upbeat"],
"coverArtUrl": "https://www.example.com/bindinglights/cover.png",
"lyricsUrl": "https://www.example.com/bindinglights/lyrics.txt",
"description": "Song by The Weeknd",
"compositionCopyrightOwner": "© The Weeknd",
"compositionCopyrightYear": 2022
"duration": 132202,
"streamUrl": "https://www.example.com/bindinglights/blinding_lights.m4a",
"nftPolicyId": "11123344555",
"nftPolicyName": "Blinding Lights NFT",
"audioEncodingStatus": "Completed",
"mintingStatus": "Minted",
"marketplaceStatus": "Selling"
},
},
{
"tokenAmount": 50000000,
"song": {
"id": "5cd11788-4cc1-4768-b4fa-4c0f519a94c5",
"archived": false,
"ownerId": "842f5460-76f8-41d8-add9-d043a7a381de",
"createdAt": "2022-05-22T20:46:46.738741",
"title": "Save Your Tears",
"genres": ["Synthwave", "Synthpop"],
"moods": ["Sentimental", "Sophisticated"],
"coverArtUrl": "https://www.example.com/saveyourtears/cover.png",
"lyricsUrl": "https://www.example.com/saveyourtears/lyrics.txt",
"description": "Song by The Weeknd",
"compositionCopyrightOwner": "© The Weeknd",
"compositionCopyrightYear": 2023
"duration": 143200,
"streamUrl": "https://www.example.com/saveyourtears/save_your_tears.m4a",
"nftPolicyId": "4444555666",
"nftPolicyName": "Save Your Tears NFT",
"audioEncodingStatus": "Completed",
"mintingStatus": "Minted",
"marketplaceStatus": "NotSelling"
}
}
]
}
Code: 401 UNAUTHORIZED
Condition: If {accessToken}
is invalid or expired.
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"
}