Get collection value

Count a wallet’s collectibles and total their estimated fair market value (FMV)

curl --request GET \
  --url https://api.renaiss.xyz/v2/users/{walletAddress} \
  --header 'x-builder-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-builder-api-key': '<api-key>'}};

fetch('https://api.renaiss.xyz/v2/users/{walletAddress}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "collectibleCount": 123,
  "totalRixPriceInUsd": "<string>",
  "collectiblesWithoutRixPrice": 123
}

{
  "code": "WRONG_REQUEST_PARAMS",
  "message": "Bad request - invalid parameters"
}

{
  "error": "Required authentication credential is missing",
  "code": "API_AUTH_MISSING_CREDENTIAL"
}

{
  "error": "Credential is not allowed by this policy",
  "code": "API_AUTH_CREDENTIAL_NOT_ALLOWED"
}

{
  "error": "Authentication rate limit exceeded",
  "code": "API_AUTH_RATE_LIMITED"
}

Internal Server Error

GET

users

{walletAddress}

Count a wallet’s collectibles and total their estimated fair market value (FMV)

curl --request GET \
  --url https://api.renaiss.xyz/v2/users/{walletAddress} \
  --header 'x-builder-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-builder-api-key': '<api-key>'}};

fetch('https://api.renaiss.xyz/v2/users/{walletAddress}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "collectibleCount": 123,
  "totalRixPriceInUsd": "<string>",
  "collectiblesWithoutRixPrice": 123
}

{
  "code": "WRONG_REQUEST_PARAMS",
  "message": "Bad request - invalid parameters"
}

{
  "error": "Required authentication credential is missing",
  "code": "API_AUTH_MISSING_CREDENTIAL"
}

{
  "error": "Credential is not allowed by this policy",
  "code": "API_AUTH_CREDENTIAL_NOT_ALLOWED"
}

{
  "error": "Authentication rate limit exceeded",
  "code": "API_AUTH_RATE_LIMITED"
}

Internal Server Error

The count and value cover the same cards as the unfiltered collection. Query the address that holds the cards. A signer and its Safe have separate totals. Renaiss custody wallets return an empty collection.Each card’s RIX price is its estimated fair market value (FMV). The totalRixPriceInUsd field sums the available RIX prices in USD cents. Show collectiblesWithoutRixPrice alongside the total so readers can see how many cards lack an estimate.

Request

Builder key required

Response

Error codes

Match the HTTP status and response text to a row below. For guidance on codes shared across endpoints, see Error meanings and recovery.

HTTP	Error code	Text field	Response text and recovery
`400`	`WRONG_REQUEST_PARAMS`	`message`	`Bad request - invalid parameters` A field is missing, unknown or has the wrong form. Fix the request and send it again.
`401`	`API_AUTH_INVALID_CREDENTIAL`	`error`	`Invalid authentication credential` The builder key is malformed, unknown, expired or revoked. Check the key. Do not retry with the same key.
`401`	`API_AUTH_MISSING_CREDENTIAL`	`error`	`Required authentication credential is missing` No builder key was sent. Send your builder key in the `x-builder-api-key` header.
`403`	`API_AUTH_CREDENTIAL_NOT_ALLOWED`	`error`	`Credential is not allowed by this policy` This route takes a builder key only. Remove the `Authorization` header and any other credential, then send the request again.
`403`	`GACHA_V3_BUILDER_NOT_ACCEPTED_ON_PUBLIC_API`	`error`	`This builder checks out on its own surface, not on the public API` This builder key cannot be used on this API. Do not retry; contact Renaiss.
`429`	`API_AUTH_RATE_LIMITED`	`error`	`Authentication rate limit exceeded` The builder key hit its rate limit. Wait a little, then retry at a lower rate.
`500`	`API_AUTH_ERROR`	`error`	`Internal server error`
`500`	`FUNCTION_ERROR`	`error`	`Internal server error`
`500`	Other code	`error`	`Internal server error`
`500`	No code	`text/plain`	`Internal Server Error`

Authorizations

x-builder-api-key

string

header

required

Your approved builder API key. Keep it on your backend. Gacha and marketplace writes also require wallet action signatures. Redeem also needs a wallet access token, a Bearer token the API issues after the wallet signs a sign-in message.

Path Parameters

walletAddress

string

required

The wallet to read. Exactly this address.

Response

Success

collectibleCount

integer

required

How many collectibles GET /v2/users/{walletAddress}/collectibles lists for the wallet and your builder key.

totalRixPriceInUsd

string

required

The sum of the available RIX prices (estimated FMVs) in USD cents. Each card contributes its rixPriceInUsd value.

collectiblesWithoutRixPrice

integer

required

The number of collectibles that have no RIX price (estimated FMV) and therefore contribute nothing to the total.

Getting started

Gacha

Marketplace

Wallet collections

Redeem and shipping

Developer resources

Partner integrations

Get collection value

Request

Response

Error codes

Authorizations

Path Parameters

Response