User Info

GET /api/v1/userInfo

  • Note: To return a user's information. If the Parameters are empty, then it is to query the caller's own user information.

  • Header

FieldTypeRequiredRemarks

ApiKey

String

true

ApiKey acquired from the admin

Authorization

String

false

Bearer ${unifiedAuthToken} , in which the unifiedAuthToken is the result returned by /api/v1/auth

  • Request Parameters

FieldTypeRequiredRemarks

address

String

false

relationId or address

fields

List[String]

false

option,Fill in the user fields that need to be returned,value: CREATE_AT、FOLLOW_COUNT、ADDRESS_WITH_CHAIN

  • Request Example

curl  GET 'https://api.relationlabs.ai/api/v1/userInfo?address=0x9bd286ef4e3d9ec1af6c6ae9da2f0b3617deab13' \
--header 'ApiKey: <ApiKey>'
  • Response Parameters

FieldTypeRemarks

code

String

the Return Code

desc

String

the Return Message

data

UserInfo

the Data

The UserInfo field consists of the following subfields:

FieldTypeRemarks

name

String

User Name

avatar

String

User's Avatar

relationId

String

User's relationId

createdAt

String

User's register time

followCount

FollowCount

Total number of followers and following

└─followingCount

Integer

Total number of following

└─followerCount

Integer

Total number of followers

addressWithChain

AddressWithChain

User's address ,and the chain which the address belongs

└─address

String

└─chainName

String

the chain name,current support:eth、polygon、bsc、op、moonbeam、solana、flow、substrate、ic、

  • Response Example

{
    "code": "0",
    "desc": "success",
    "data": {
        "relationId": "dhkyq-sqaaa-aaaaj-sgz3q-cai",
        "name": "0x1e56",
        "avatar": "",
        "createdAt": "2022-08-18 16:54:15",
        "followCount": {
            "followingCount": 1,
            "followerCount": 0
        },
        "addressWithChain": [
            {
                "address": "0xb152e0eebd5d2b98da5d1ed7d1ce066c20a4e430",
                "chainName": "eth"
            }
        ]
    }
}
  • Return Code

codedescRemarks

0

success

the flag for a successful request

11601

failed

this field not support in current version

11602

failed

user not found

Last updated