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

Friends

Get all friendships by status

get

Returns every friendship of the authenticated user with the given status, both sent and received.

Authorizations
api-keystringRequired

Your public API key

signaturestringRequired

HMAC SHA256 or ML-DSA44 signature of the request

timestampstringRequired

Unix timestamp used for request signing

Path parameters
statusstring · enumRequired

Friendship status

Possible values:
Responses
200

List of friendships

application/json
Friend[]Optional
get/api/v2/account/friend/all/{status}
GET /api/v2/account/friend/all/{status} HTTP/1.1
Host: api.sigrex.io
api-key: YOUR_API_KEY
signature: YOUR_API_KEY
timestamp: YOUR_API_KEY
Accept: */*
[]

Get paginated friendships by status and side

get
Authorizations
api-keystringRequired

Your public API key

signaturestringRequired

HMAC SHA256 or ML-DSA44 signature of the request

timestampstringRequired

Unix timestamp used for request signing

Path parameters
statusstring · enumRequired

Friendship status

Possible values:
sidestring · enumRequired

Requests sent by the user, received by the user, or both

Possible values:
Query parameters
pageintegerRequired

Page number (1-indexed)

limitintegerRequired

Page size, max 100 (larger values are capped to 100)

Responses
200

Paginated list of friendships

application/json
totalintegerOptional
dataFriend[]Optional
get/api/v2/account/friend/{status}/{side}
GET /api/v2/account/friend/{status}/{side}?page=1&limit=1 HTTP/1.1
Host: api.sigrex.io
api-key: YOUR_API_KEY
signature: YOUR_API_KEY
timestamp: YOUR_API_KEY
Accept: */*
{
  "total": 1,
  "data": []
}

Get paginated rejected friend requests

get

Returns friend requests received by the authenticated user that were rejected.

Authorizations
api-keystringRequired

Your public API key

signaturestringRequired

HMAC SHA256 or ML-DSA44 signature of the request

timestampstringRequired

Unix timestamp used for request signing

Query parameters
pageintegerRequired

Page number (1-indexed)

limitintegerRequired

Page size, max 100 (larger values are capped to 100)

Responses
200

Paginated list of rejected friend requests

application/json
totalintegerOptional
dataFriend[]Optional
get/api/v2/account/friend/rejected
GET /api/v2/account/friend/rejected?page=1&limit=1 HTTP/1.1
Host: api.sigrex.io
api-key: YOUR_API_KEY
signature: YOUR_API_KEY
timestamp: YOUR_API_KEY
Accept: */*
{
  "total": 1,
  "data": []
}

Last updated