Prepare a purchase

Prepare a purchase at the displayed ask price

curl --request POST \
  --url https://dev-api.renaiss.xyz/v2/marketplace/buy/prepare \
  --header 'Content-Type: application/json' \
  --header 'x-builder-api-key: <api-key>' \
  --data '
{
  "tokenId": "9007199254740993",
  "walletAddress": "0x1111111111111111111111111111111111111111",
  "expiresAt": null,
  "expectedTotalPriceInUsdt": "102000000000000000000"
}
'

const options = {
  method: 'POST',
  headers: {'x-builder-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tokenId: '9007199254740993',
    walletAddress: '0x1111111111111111111111111111111111111111',
    expiresAt: null,
    expectedTotalPriceInUsdt: '102000000000000000000'
  })
};

fetch('https://dev-api.renaiss.xyz/v2/marketplace/buy/prepare', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://dev-api.renaiss.xyz/v2/marketplace/buy/prepare"

payload = {
    "tokenId": "9007199254740993",
    "walletAddress": "0x1111111111111111111111111111111111111111",
    "expiresAt": None,
    "expectedTotalPriceInUsdt": "102000000000000000000"
}
headers = {
    "x-builder-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "operation": "bid",
  "tokenId": "<string>",
  "buyerWalletAddress": "<string>",
  "quote": {
    "amountInUsdt": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "typedData": {
    "domain": {},
    "types": {},
    "primaryType": "<string>",
    "message": {}
  },
  "payload": {
    "collectibleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bidData": {
      "bidder": "<string>",
      "feeBps": "<string>",
      "tokenId": "<string>",
      "amount": "<string>",
      "nonce": "<string>",
      "deadline": "<string>"
    }
  }
}

Malformed JSON in request body

{
  "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": "Collectible not found",
  "code": "COLLECTIBLE_NOT_FOUND"
}

{
  "error": "Ask price changed",
  "code": "WRONG_REQUEST_PARAMS"
}

Payload Too Large

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

Internal Server Error

POST

marketplace

buy

prepare

Prepare a purchase at the displayed ask price

curl --request POST \
  --url https://dev-api.renaiss.xyz/v2/marketplace/buy/prepare \
  --header 'Content-Type: application/json' \
  --header 'x-builder-api-key: <api-key>' \
  --data '
{
  "tokenId": "9007199254740993",
  "walletAddress": "0x1111111111111111111111111111111111111111",
  "expiresAt": null,
  "expectedTotalPriceInUsdt": "102000000000000000000"
}
'

const options = {
  method: 'POST',
  headers: {'x-builder-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tokenId: '9007199254740993',
    walletAddress: '0x1111111111111111111111111111111111111111',
    expiresAt: null,
    expectedTotalPriceInUsdt: '102000000000000000000'
  })
};

fetch('https://dev-api.renaiss.xyz/v2/marketplace/buy/prepare', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://dev-api.renaiss.xyz/v2/marketplace/buy/prepare"

payload = {
    "tokenId": "9007199254740993",
    "walletAddress": "0x1111111111111111111111111111111111111111",
    "expiresAt": None,
    "expectedTotalPriceInUsdt": "102000000000000000000"
}
headers = {
    "x-builder-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "operation": "bid",
  "tokenId": "<string>",
  "buyerWalletAddress": "<string>",
  "quote": {
    "amountInUsdt": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "typedData": {
    "domain": {},
    "types": {},
    "primaryType": "<string>",
    "message": {}
  },
  "payload": {
    "collectibleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bidData": {
      "bidder": "<string>",
      "feeBps": "<string>",
      "tokenId": "<string>",
      "amount": "<string>",
      "nonce": "<string>",
      "deadline": "<string>"
    }
  }
}

Malformed JSON in request body

{
  "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": "Collectible not found",
  "code": "COLLECTIBLE_NOT_FOUND"
}

{
  "error": "Ask price changed",
  "code": "WRONG_REQUEST_PARAMS"
}

Payload Too Large

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

Internal Server Error

Send the exact asking price the buyer reviewed. If it changed, refresh the order book and show the new price. Once the buyer signs, submit the purchase.On testnet, send expiresAt: null for the default expiry. Until the mainnet release, omit both expiresAt and expiresInSeconds for the mainnet default.The buyer must have enough USDT approved for Permit2 when submitting the purchase.

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`	`MATCHING_ASK_NOT_FOUND`	`error`	`Ask is no longer available` The collectible has no active listing. Read the listings again; do not retry this request.
`400`	`MATCHING_ASK_PERMIT_NOT_FOUND`	`error`	`Stored ask payload is invalid` The listing cannot be bought. Read the listings again; do not retry this request.
`400`	`WRONG_REQUEST_PARAMS`	`error`	`Invalid marketplace request: tokenId: Required` `Invalid marketplace request: expiresAt: Required` `expiresAt must be null or a future UTC timestamp within 180 days` Check the field named in the error. For the default expiry, send `"expiresAt": null`.
`400`	No code	`text/plain`	`Malformed JSON in request body`
`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.
`404`	`COLLECTIBLE_NOT_FOUND`	`error`	`Collectible not found` The token id is unknown or the collectible is not available on this API. Check the token id. Do not retry with the same id.
`409`	`WRONG_REQUEST_PARAMS`	`error`	`Ask price changed` The price of the listing is not the price you sent. Read the current price and prepare again.
`413`	No code	`text/plain`	`Payload Too Large`
`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`	No code	`text/plain`	`Internal Server Error`
`500`	`COLLECTIBLE_GET_FAILED`	`error`	`Internal server error` If this persists, contact Renaiss with `x-request-id`.

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.

Body

application/json

tokenId

string

required

On-chain card ID as a decimal uint256 string.

Pattern: ^\d+$

Example:

"9007199254740993"

walletAddress

string

required

expiresAt

string<date-time> | null

required

Send JSON null for 30 days from preparation, or a future UTC timestamp ending in Z within 180 days. Include this field in every trade preparation.

Pattern: Z$

Example:

null

expectedTotalPriceInUsdt

string

required

Total asking price the buyer reviewed, in 18-decimal USDT base units. A price change returns HTTP 409.

Pattern: ^0*[1-9][0-9]*$

Response

Success

operation

enum<string>

required

Available options:

bid,

buy

tokenId

string

required

Pattern: ^\d+$

buyerWalletAddress

string

required

20-byte, 0x-prefixed wallet or contract address. Use lowercase or a valid checksum.

quote

object

required

Show child attributes

typedData

object

required

Show child attributes

payload

object

required

Show child attributes

Getting started

Gacha

Marketplace

Wallet collections

Redeem and shipping

Developer resources

Partner integrations

Prepare a purchase

Request

Response

Error codes

Authorizations

Body

Response