🎊Explorer API

We are not currently open to the public for our API application, please submit your information from here and we will configure a dedicated [ DappKey ]

POST /interfa/v1/auth

ParamTypeRequired?Description

Token

String

Required

Dappkey acquired from the admin

Returns a JSON object containing the AccessToken and RefreshToken.

Example:

curl -X POST 'https://exdapps.uxlink.io/interfa/v1/auth' \
-H 'Token: <DappKey>' \
-H 'Content-Type: application/json'
// Response Example
{
    "success": true,
    "msg": "ok",
    "code": 200,
    "data": {
        "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NzM0ODE5OTMsImlhdCI6MTcxMDQwOTk5Mywiand0RGFwcElasdc3123oiQzI1NUtRMFBTVlk0UjZX1231DYxUjRHUTUwQ09PSVZSSVUifQ.nlg5vzO-0XjRzqg3z-90F-O1YbnRyFj8btpWyFAI_SI",
        "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NzM0ODE5OTMsImlhdCI6MTcxMDQwOTk5Mywiand0RGFwcElkIjoiQzI1NUtRMFBTVlk0UjROVDYxUjRasas2ewQ09PSVZSSVUifQ.nlg5vzO-0XjRzqg3z-90F-O1YbnRyFj8btpWyFAI_SI",
        "accessExpire": 162341315435,
        "refreshAfter": 162341315435
    }
}

POST /interfa/v1/login/account

ParamTypeRequired?Description

Authorization

String

Required

Get AccessToken from /interfa/v1/auth

address

String

Required

Wallet Address

Returns a JSON object providing the user's information, AccountInfo.

Example:

curl -X POST 'https://exdapps.uxlink.io/interfa/v1/login/account' \
-H 'Authorization: <AccessToken>' \
-H 'Content-Type: application/json' \
-d '{
  "address": "0xc593e54A2016ea8FD71a4F62974BeC65f74C909C",
}'
// Response Example:
{
    "success": true,
    "msg": "ok",
    "code": 200,
    "data": {
	"accountInfo": {
            "uxuyId": "4A2016ea8X2dsa2", //userId
            "name": "uxlink",
            "avatar": "https://avatar.jpg", 
            "address": "0xc593e54A2016ea8FD71a4F62974BeC65f74C909C", //UXWallet Address
        }
    }
}

POST /interfa/v1/user/relation/list

ParamTypeRequired?Description

Authorization

String

Required

Get AccessToken from /interfa/v1/auth

pageSize

Int

Required

20

nextToken

String

Required

pageSize can be null if it is 1, otherwise get it in the returned JSON.

address

String

Required

Wallet Address

Returns a JSON object, i.e. the user's social data.

Example:

curl -X POST 'https://exdapps.uxlink.io/interfa/v1/user/relation/list' \
-H 'Authorization: <AccessToken>' \
-H 'Content-Type: application/json' \
-d '{
  "pageSize": 20,
  "nextToken": "eyJleHAiOjE3NzM0ODE5OTMsImlhdCI6MTcxMDQwOTk5Mywiand0RGFwcElkIjoiQzI1NUtRMFBTVlk0UjROVDYxUjRasas2ewQ09PSVZSSVUifQ",
  "address": "0xc593e54A2016ea8FD71a4F62974BeC65f74C909C"
}' 
// Response Example:
{
    "success": true,
    "msg": "ok",
    "code": 200,
    "data": {
      "pageSize": 20, 
      "nextPage": true,
      "nextToken": "eyJleHAiOjE3NzM0ODE5OTMsImlhdCI",
	   "list": [
	       {
		  "uxuyId": "12313100000000", 
		  "name": "ali", 
		  "avatar": "https://dsdfsdfs.jpg", 
	          "address": "0x24234234234234", 
	       },
            ]
    }
}

POST https://openapi.uxlink.io/interfa/v1/user/wallet/list

ParamTypeRequired?Description

Authorization

String

Required

Get AccessToken from /interfa/v1/auth

address

String

Optional

Uxwallet address. Required when field "uxuyId" is missing.

uxuyId

String

Optioanl

Uxuy ID. Required when field "address" is missing.

Returns a JSON object providing total reward amount and limit.

Example:

curl -X POST 'https://openapi.uxlink.io/interfa/v1/user/wallet/list' \
-H 'Authorization: <AccessToken>' \
-H 'Content-Type: application/json' \
-d '{
	"address": "0x1231223423423423123",
	"uxuyId": "1231231243242"
}'
// Success Response Example:
{
    "success": true,
    "msg": "ok",
    "code": 200,
    "data": {
		  "walletList": [
		    {
				"uxuyId": "1231231243242", 
				"address": "0xdf1312312423423423542534534",
				"walletType": 1,
				"verified": true
			  }
		  ]
		}
}

POST /interfa/v1/trade2earn

ParamTypeRequired?Description

Authorization

String

Required

Get AccessToken from /interfa/v1/auth

address

String

Required

Wallet Address

orderId

String

Required

Order ID (business number, trade number, etc. should not duplicate)

amount

float64

Required

Amount of reward

tx

String

Optional

Transaction

chainType

String

Required when "tx" existed

Chain type. enum(EVM, Non-EVM)

chainId

string

Required when "tx" existed

EVM Chain ID

chainName

String

Required when "tx" existed

Chain name, specially for Non-EVM chain. enum(x1, eth, sol, arb, base, polygon, scroll, zksync)

orderTime

int64

Required

Order creation timestamp (s)

orderDesc

String

Optional

Order description maxLength: 255

Returns a JSON object providing result of recording.

Example:

curl -X POST 'https://exdapps.uxlink.io/interfa/v1/trade2earn' \
-H 'Authorization: <AccessToken>' \
-H 'Content-Type: application/json' \
-d '{
  "address": "0xc593e54A2016ea8FD71a4F62974BeC65f74C3333",
  "orderId": "NO22344556678888",
  "amount": 100,
  "tx": "0x1855b5beed926427969a91f4544059d2c2bbb31e27ac1c4f3cd96798f560bb33",
  "chainType": "EVM",
  "chainId": "8453",
  "chainName": "base",
  "orderTime": 1717171200,
  "orderDesc": "wonderful deal"
}'
// Success Response Example:
{
    "success": true,
    "msg": "ok",
    "code": 200,
    "data": {}
}
// DuplicateOrderId error Response Example:
{
    "success": false,
    "code": 10101062,
    "msg": "duplicate order id"
}
// TotalAmountOverLimit error Response Example:
{
    "success": false,
    "code": 10101001,
    "msg": "total amount over limit"
}

POST /interfa/v1/trade2earn/summary

ParamTypeRequired?Description

Authorization

String

Required

Get AccessToken from /interfa/v1/auth

Returns a JSON object providing total reward amount and limit.

Example:

curl -X POST 'https://exdapps.uxlink.io/interfa/v1/trade2earn/summary' \
-H 'Authorization: <AccessToken>' \
-H 'Content-Type: application/json' \
// Success Response Example:
{
    "success": true,
    "msg": "ok",
    "code": 200,
    "data": {
        "totalAmount": 567000,
        "totalAmountMax": 1000000
    }
}

POST /interfa/v1/trade2earn/subtotal

ParamTypeRequired?Description

Authorization

String

Required

Get AccessToken from /interfa/v1/auth

address

String

Required

Wallet Address

orderIdPrefix

String

Optional

Order ID prefix

Returns a JSON object providing subtotal reward amount by address and orderId prefix.

Example:

curl -X POST 'https://exdapps.uxlink.io/interfa/v1/trade2earn/subtotal' \
-H 'Authorization: <AccessToken>' \
-H 'Content-Type: application/json' \
-d '{
  "address": "0xc593e54A2016ea8FD71a4F62974BeC65f74C3333",
  "orderIdPrefix": "NO223445566"
}'
// Success Response Example:
{
    "success": true,
    "msg": "ok",
    "code": 200,
    "data": {
        "subtotalAmount": 567000
    }
}

Code

CodeDescRemarks

200

success

the flag for a successful request

5001002

false

Last updated