Get burn details by uid

Suggest Edits

🚧

Important:

Request headers are required. See API basics introduction for more information.

Get burn details by uid

Endpoint

GET burn/{uid}

Returns the burn details for a given uid associated with the given App (set by the X-API-KEY).

Parameters

Query parameters

Query parameterDescription
uidThe unique identifier of the Burn for this app (ex. 213134081289).

Response

You will receive the burn details including the following fields:

Response fieldsTypeDescriptionCondition
uidStringThe UID of the burn.Mandatory
statusStringThe status of the burn (pending | done).Mandatory
asset_uidStringThe UID of the asset burned.Mandatory
from_user_uidStringThe UID of the user who is burning the asset.Mandatory
created_atString
(Timestamp)		The timestamp of the burn creation.Mandatory

Response example

{
    "success": true,
    "data": {
        "uid": "213134081289",
        "status": "Pending",
        "asset_uid": "112144981245",
        "from_user_uid": "223144788242",
        "created_at": "2023-08-10T14:07:14.494142Z",
    }
}

Example

The following example gets the burn details for burn 444444444444.

# API_KEY is your api key
# TOKEN is the access token generated with your api key secret

curl -i \
  -X GET \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: API_KEY" \
  -H "Authorization: Bearer TOKEN" \
  "https://api.getoriginal.com/v1/burn/444444444444"

Updated 5 months ago