Get Track Access Info

GET 
/tracks/:track_id/access-info

Gets the information necessary to access the track and what access the given user has.

Request

Path Parameters

track_id stringrequired

A Track ID

Query Parameters

user_id string

The user ID of the user making the request

Responses

200

Success

application/json

Schema

Schema

data

object

access

object

stream boolean

download boolean

user_id stringrequired

The user ID of the owner of this track

blocknumber integerrequired

The blocknumber this track was last updated

is_stream_gated boolean

Whether or not the owner has restricted streaming behind an access gate

stream_conditions

object

oneOf

MOD1

tip_user_id integerrequired

Must tip the given user ID to unlock

MOD2

follow_user_id integerrequired

Must follow the given user ID to unlock

MOD3

usdc_purchase

object

required

Must pay the total price and split to the given addresses to unlock

price integerrequired

splits

object[]

required

Array [

user_id integerrequired

percentage numberrequired

eth_wallet stringrequired

payout_wallet stringrequired

amount integerrequired

]

MOD4

nft_collection

object

required

Must hold an NFT of the given collection to unlock

chain stringrequired

Possible values: [eth, sol]

address stringrequired

name stringrequired

imageUrl string

externalLink string

is_download_gated boolean

Whether or not the owner has restricted downloading behind an access gate

download_conditions

object

oneOf

MOD1

tip_user_id integerrequired

Must tip the given user ID to unlock

MOD2

follow_user_id integerrequired

Must follow the given user ID to unlock

MOD3

usdc_purchase

object

required

Must pay the total price and split to the given addresses to unlock

price integerrequired

splits

object[]

required

Array [

user_id integerrequired

percentage numberrequired

eth_wallet stringrequired

payout_wallet stringrequired

amount integerrequired

]

MOD4

nft_collection

object

required

Must hold an NFT of the given collection to unlock

chain stringrequired

Possible values: [eth, sol]

address stringrequired

name stringrequired

imageUrl string

externalLink string

Example

{
  "data": {
    "access": {
      "stream": true,
      "download": true
    },
    "user_id": "qm4Ya",
    "blocknumber": 75099561,
    "is_stream_gated": false,
    "stream_conditions": null,
    "is_download_gated": false,
    "download_conditions": null
  }
}

Loading...