For the complete documentation index, see llms.txt. This page is also available as Markdown.

Friends

Get friends (addresses only)

get
/v2/friends

Returns a paginated list of the addresses of the authenticated user's friends. The response has no profile information: clients resolve the profiles themselves.

Authorizations
AuthorizationstringRequired

Signed Fetch authentication. See ADR-44 for more details about the authentication mechanism.

Query parameters
limitinteger · min: 1 · max: 100Optional

Number of results per page. Values above the maximum are reduced to it.

Default: 100
offsetintegerOptional

Number of results to skip. Values above 100000 are clamped to 100000.

Default: 0
Responses
200

Friends of the authenticated user

application/json
get/v2/friends
GET /v2/friends HTTP/1.1
Host: social-api.decentraland.org
Authorization: YOUR_API_KEY
Accept: */*
{
  "data": {
    "results": [
      {
        "address": "text"
      }
    ],
    "total": 1,
    "limit": 1,
    "offset": 1,
    "page": 1,
    "pages": 1
  }
}

Remove a friend

delete
/v1/friends/{address}

Ends the friendship between the authenticated user and address.

Authorizations
AuthorizationstringRequired

Signed Fetch authentication. See ADR-44 for more details about the authentication mechanism.

Path parameters
addressstringRequired

Ethereum address of the other user

Responses
204

Friendship ended

No content

delete/v1/friends/{address}
DELETE /v1/friends/{address} HTTP/1.1
Host: social-api.decentraland.org
Authorization: YOUR_API_KEY
Accept: */*

No content

Get mutual friends (addresses only)

get
/v2/users/{address}/mutual-friends

Returns a paginated list of the addresses of the friends the authenticated user and address have in common, without profile information.

Authorizations
AuthorizationstringRequired

Signed Fetch authentication. See ADR-44 for more details about the authentication mechanism.

Path parameters
addressstringRequired

Ethereum address of the other user

Query parameters
limitinteger · min: 1 · max: 100Optional

Number of results per page. Values above the maximum are reduced to it.

Default: 100
offsetintegerOptional

Number of results to skip. Values above 100000 are clamped to 100000.

Default: 0
Responses
200

Mutual friends

application/json
get/v2/users/{address}/mutual-friends
GET /v2/users/{address}/mutual-friends HTTP/1.1
Host: social-api.decentraland.org
Authorization: YOUR_API_KEY
Accept: */*
{
  "data": {
    "results": [
      {
        "address": "text"
      }
    ],
    "total": 1,
    "limit": 1,
    "offset": 1,
    "page": 1,
    "pages": 1
  }
}

Get the friendship status with a user

get
/v1/users/{address}/friendship-status

Returns the status of the friendship between the authenticated user and address.

Authorizations
AuthorizationstringRequired

Signed Fetch authentication. See ADR-44 for more details about the authentication mechanism.

Path parameters
addressstringRequired

Ethereum address of the other user

Responses
200

Friendship status

application/json
get/v1/users/{address}/friendship-status
GET /v1/users/{address}/friendship-status HTTP/1.1
Host: social-api.decentraland.org
Authorization: YOUR_API_KEY
Accept: */*
{
  "data": {
    "status": 1
  }
}

Get pending friendship requests (addresses only)

get
/v2/friendship-requests

Returns a paginated list of the pending friendship requests the authenticated user received or sent. Each request carries the other user's address instead of their profile.

Authorizations
AuthorizationstringRequired

Signed Fetch authentication. See ADR-44 for more details about the authentication mechanism.

Query parameters
directionstring · enumRequired

Whether to list the requests the user received or the ones they sent

Possible values:
limitinteger · min: 1 · max: 100Optional

Number of results per page. Values above the maximum are reduced to it.

Default: 100
offsetintegerOptional

Number of results to skip. Values above 100000 are clamped to 100000.

Default: 0
Responses
200

Pending friendship requests

application/json
get/v2/friendship-requests
GET /v2/friendship-requests?direction=received HTTP/1.1
Host: social-api.decentraland.org
Authorization: YOUR_API_KEY
Accept: */*
{
  "data": {
    "results": [
      {
        "id": "text",
        "address": "text",
        "createdAt": 1,
        "message": "text"
      }
    ],
    "total": 1,
    "limit": 1,
    "offset": 1,
    "page": 1,
    "pages": 1
  }
}

Send a friendship request

post
/v1/friendship-requests

Sends a friendship request from the authenticated user to address.

Authorizations
AuthorizationstringRequired

Signed Fetch authentication. See ADR-44 for more details about the authentication mechanism.

Body
addressstringRequired

Ethereum address of the user to send the request to

Example: 0x0000000000000000000000000000000000000001
messagestring · max: 256Optional

Optional message sent along with the request, limited to 256 Unicode code points

Responses
201

Friendship request sent, with the receiver's address

application/json
post/v1/friendship-requests
POST /v1/friendship-requests HTTP/1.1
Host: social-api.decentraland.org
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "address": "0x0000000000000000000000000000000000000001",
  "message": "text"
}
{
  "data": {
    "id": "text",
    "address": "text",
    "createdAt": 1,
    "message": "text"
  }
}

Accept, reject or cancel a friendship request

patch
/v1/friendship-requests/{address}

Resolves the pending friendship request between the authenticated user and address. There is at most one pending request per pair of users, so the other user's address identifies it. The receiver can accept or reject it, and the sender can cancel it.

Authorizations
AuthorizationstringRequired

Signed Fetch authentication. See ADR-44 for more details about the authentication mechanism.

Path parameters
addressstringRequired

Ethereum address of the other user

Body
intentionstring · enumRequiredPossible values:
Responses
200

Friendship request updated, with the other user's address

application/json
patch/v1/friendship-requests/{address}
PATCH /v1/friendship-requests/{address} HTTP/1.1
Host: social-api.decentraland.org
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "intention": "accepted"
}
{
  "data": {
    "id": "text",
    "address": "text",
    "createdAt": 1,
    "message": "text"
  }
}

Last updated