Retrieve a Project
This endpoint allows you to retrieve a Project by providing the Project type (n or t) and Project ID.
Authorizations
Path parameters
transferablestringRequired
Value must be either 't' for transferable or 'n' for non-transferable
projectIdintegerRequired
Query parameters
pagenumber | nullableOptional
limitnumber | nullableOptional
sortBystringOptional
orderBystring · enumOptionalPossible values:
Responses
200
Returns a Project with a paginated list of NFTs
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
get
GET /v2/projects/:transferable/:projectId HTTP/1.1
Host: api.underdogprotocol.com
Authorization: Bearer JWT
Accept: */*
{
"name": "NFT #1",
"symbol": "NFT",
"description": "This is my first NFT",
"image": "https://example.com/image.png",
"animationUrl": "https://example.com/animation.mp4",
"id": 1,
"mintAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
"transferable": true,
"status": "text",
"nfts": {
"results": [
{
"name": "NFT #1",
"symbol": "NFT",
"description": "This is my first NFT",
"image": "https://example.com/image.png",
"animationUrl": "https://example.com/animation.mp4",
"attributes": {
"Points": "40000",
"Nickname": "LeGoat"
},
"id": 1,
"projectId": 1,
"transferable": true,
"mintAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
"ownerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
"claimerAddress": "EBeLw5jEdrEgDe17BdKGW2MizzGxtxigEuAGvYC7VzDp",
"status": "text"
}
],
"page": 1,
"limit": 10,
"totalPages": 1,
"totalResults": 1
}
}
Example
curl --location --request GET 'https://dev.underdogprotocol.com/v2/projects/n/4' \
--header 'Authorization: Bearer {token}'
{
"id": 4,
"transferable": false,
"status": "confirmed",
"mintAddress": "7eq4L3mxaaZxLw5JGP2dDtoYA71vPoRvszSUYSbqxGgF",
"ownerAddress": "3ZBGxWRQdKTaXRcyLapMn1LaSU5TbKnBKJ6m2jBERKAp",
"name": "Project #420",
"image": "https://underdog-test-bucket-dev.s3.amazonaws.com/7eq4L3mxaaZxLw5JGP2dDtoYA71vPoRvszSUYSbqxGgF/image.png",
"nfts": {
"results": [],
"page": 1,
"limit": 10,
"totalPages": 0,
"totalResults": 0
}
}
Last updated