# 共同好友

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

* 说明：通过这个 API，你可以验证或查询两个或两个以上的账号或地址之间的共同好友列表。
* Header

| Field  | Type   | Required | Remarks                                                                                 |
| ------ | ------ | -------- | --------------------------------------------------------------------------------------- |
| ApiKey | String | true     | 从管理员获取的 [ApiKey](https://relationlabs.gitbook.io/relation-graph/g-zh/api/mutual-friend) |

* Request Parameters

| Field           | Type   | Required                        | Remarks          |
| --------------- | ------ | ------------------------------- | ---------------- |
| address         | List   | fasle                           | EOA Address      |
| twitterUsername | List   | fasle                           | twitter username |
| steamId         | List   | fasle                           | steamId          |
| limit           | int    | 每次查询数量，上限100                    |                  |
| cursor          | string | 上一页返回的 cursor数据，cursor为空表示查询第一页 |                  |

* Request Example

```shell
curl  GET 'https://api.relationlabs.ai/api/v1/mutualFriend?address=0x9bd286ef4e3d9ec1af6c6ae9da2f0b3617deab13,0x1ac286ef4e3d9ec1af6c6ae9da2f0b3617deab22&limit=10&cursor=a1228c5910a04c94b70e18694d72cbb0' \
--header 'ApiKey: <ApiKey>'
```

* Response Parameters

| Field | Type   | Remarks |
| ----- | ------ | ------- |
| code  | String | 返回码     |
| desc  | String | 返回信息    |
| data  | List   | 数据      |

The UserInfo field consists of the following subfields:

| Field      | Type     | Remarks      |
| ---------- | -------- | ------------ |
| relationId | Relation | Relation用户信息 |
| address    | List     | 地址列表         |
| avatar     | String   | 用户头像         |
| twitter    | Twitter  | 推特信息         |
| steam      | Steam    | steam信息      |

* Response Body

```json
{
  "code": "0",
  "desc": "success",
  "data": {
    "cursor": "08234aadfbadfasdf",
    "list": [
      {
        "address": [],
        "relation": {
          "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"
        },
        "twitter": {
          "username": "VitalikButerin",
          "name": "vitalik.eth",
          "avatar": "https://pbs.twimg.com/profile_images/977496875887558661/L86xyLF4_400x400.jpg"
        },
        "steam": {
          "steamId": "178691028912",
          "name": "vitalik",
          "avatar": "https://pbs.twimg.com/profile_images/977496875887558661/L86xyLF4_400x400.jpg"
        }
      }
    ]
  }
}
```

* Return Code

| code | desc    | Remarks                           |
| ---- | ------- | --------------------------------- |
| 0    | success | the flag for a successful request |