Get list of transfer(s) by users

๐Ÿšง

Important:

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

Get list of transfer(s) by users

Endpoint

GET /transfer?user_uid={uid}

Returns the list of transfer details for a given user_uid associated with the given App (set by the X-API-KEY).

Parameters

Query parameters

Query parameterDescription
user_uidThe unique identifier of the user for this app (ex. 813231035224).

Response

You will receive the list of transfer(s) details including the following fields:

Response fieldsTypeDescriptionCondition
uidStringThe unique UID of the transfer.Mandatory
statusStringThe status of the transfer (pending | done | cancelled).Mandatory
asset_uidStringThe UID of the asset transferred.Mandatory
from_user_uidStringThe UID of the user who is transferring the asset.Mandatory
to_addressStringThe recipient's wallet address.Mandatory
created_atString
(Datetime)
The timestamp of the transfer creation.Mandatory

Response example

{
  "success": true,
  "data": [
    {
      "uid": "813231035224",
      "status": "Done",
      "asset_uid": "112144981245",
      "from_user_uid": "223144788242",
      "to_address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
      "created_at": "2023-08-10T14:07:14.494142Z",
    },
    ...
  ]
}   

Example

The following example fetches the transfers details for user 111111111111.

# 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/transfer?user_uid=111111111111"