# Relation One Profile

## <mark style="color:blue;">GET</mark> /api/v1/profile

* Through this API, you will be able to query the Profile information of Relation One users.
* Header

| Field  | Type   | Required | Remarks                                                                  |
| ------ | ------ | -------- | ------------------------------------------------------------------------ |
| ApiKey | String | true     | [ApiKey](/relation-graph/api/profile.md) obtained from the administrator |

* Request Parameters

| Field           | Type   | Required | Remarks                                                                                                                                                                                                 |
| --------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| address         | String | fasle    | EOA Address                                                                                                                                                                                             |
| twitterUsername | String | fasle    | twitter username                                                                                                                                                                                        |
| steamId         | String | fasle    | steamId                                                                                                                                                                                                 |
| sig             | String | true     | User authorization information (when provided with authorization details, developers can[use Lit Protocol to decrypt](/relation-graph/guide/use-litprotocol-to-decrypt.md) the returned results).       |
| message         | String | true     | Original text of user authorization information signature （Please refer to the original signature splicing[SIWE](https://docs.login.xyz/).The statement field needs to be **Access to User Profile.**)） |

* Request Example

```shell
curl  GET 'https://api.relationlabs.ai/api/v1/profile?address=0x9bd286ef4e3d9ec1af6c6ae9da2f0b3617deab13&sig=xxx&message=xxx' \
--header 'ApiKey: <ApiKey>'
```

* Response Parameters

| Field | Type          | Remarks                         |
| ----- | ------------- | ------------------------------- |
| code  | String        | Return code                     |
| desc  | String        | Return message                  |
| data  | EncryptedData | Data(Encrypted by Lit Protocol) |

The decrypted fields of `EncryptedData` are as follows:

| Field          | Type   | Remarks                   |
| -------------- | ------ | ------------------------- |
| relationId     | String | User's relationId         |
| name           | String | User name                 |
| avatar         | String | User's profile image      |
| followingCount | String | Total number of following |
| followerCount  | String | Total number of follower  |

The decrypted data structure of `EncryptedData` is as follows:

```json
 {
  "relationId": "d4swz-zaaaa-aaaaj-at5fa-cai",
  "name": "test_user",
  "avatar": "https://3fypb-gqaaa-aaaag-aaedq-cai.ic1.io/nft/eth/relation-test-club/16.png",
  "followingCount": 87,
  "followerCount": 999
}
```

* Response Body

```json
{
  "code": "0",
  "desc": "success",
  "data": {
    "encryptedString": "xxx",
    "encryptedSymmetricKey": "xxx"
  }
}
```

* Return Code

| code  | desc    | Remarks                                   |
| ----- | ------- | ----------------------------------------- |
| 0     | success | the flag for a successful request         |
| 11601 | failed  | this field not support in current version |
| 11602 | failed  | user not found                            |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://relationlabs.gitbook.io/relation-graph/api/profile.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.