S2S Partner Users

List the partner users

GET

https://stg-s2s.restake.gg

/api/v1/s2s/users

Newest first. Optionally narrowed by status or a search term.

List the partner users › query Parameters

page

number

Default: 1

pageSize

number

Items per page, capped at 100.

Default: 20

List the partner users › Responses

Newest first.

S2sUserView[] · required

page

number · required

1-based index of this page.

pageSize

number · required

total

number · required

Rows matching the query, across every page.

Create a user

POST

https://stg-s2s.restake.gg

/api/v1/s2s/users

The user is owned by the calling partner. email is required and must be unique across the whole platform, as must walletAddress when given.

Create a user › Request Body

CreateS2sUserDto

email

string · required

Unique across all users. Stored lowercased.

Example: [email protected]

walletAddress

string

EVM address, unique across all users. Stored lowercased. Optional: an account may be created without one and link it later, once.

Example: 0x1234567890abcdef1234567890abcdef12345678

userName

string

language

string

BCP 47 tag (en, pt-BR). Defaults to en.

Default: en

countryCode

string

ISO 3166-1 alpha-2. Must be a country the platform knows.

Example: BR

Create a user › Responses

S2sUserView · required

POST/api/v1/s2s/users

curl https://stg-s2s.restake.gg/api/v1/s2s/users \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "email": "[email protected]",
  "walletAddress": "0x1234567890abcdef1234567890abcdef12345678",
  "userName": "jane.doe",
  "language": "en",
  "countryCode": "BR"
}'

Example Request Body

{
  "email": "[email protected]",
  "walletAddress": "0x1234567890abcdef1234567890abcdef12345678",
  "userName": "jane.doe",
  "language": "en",
  "countryCode": "BR"
}

json

Example Responses

{
  "data": {
    "userId": "userId",
    "email": "email",
    "walletAddress": "walletAddress",
    "userName": "userName",
    "language": "language",
    "avatar": "avatar",
    "status": "basic",
    "countryCode": "countryCode",
    "kycLevel": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Read one user

GET

https://stg-s2s.restake.gg

/api/v1/s2s/users/{userId}

Read one user › path Parameters

userId

string · required

Read one user › Responses

S2sUserView · required

Close a user

DELETE

https://stg-s2s.restake.gg

/api/v1/s2s/users/{userId}

Moves the account to closed instead of deleting the row — a user is referenced by sessions, portfolio history and referrals, which must survive. Idempotent.

Close a user › path Parameters

userId

string · required

Close a user › Responses

S2sUserDeletedResponse · required

Update a user

PATCH

https://stg-s2s.restake.gg

/api/v1/s2s/users/{userId}

Omitted fields are left untouched. A wallet address can be set once and is never replaced.

Update a user › path Parameters

userId

string · required

Update a user › Request Body

UpdateS2sUserDto

email

string

Must stay unique.

walletAddress

string

Only settable while the user has no wallet — an existing one is never replaced.

userName

string

language

string

countryCode

string

Update a user › Responses

S2sUserView · required

PATCH/api/v1/s2s/users/{userId}

curl https://stg-s2s.restake.gg/api/v1/s2s/users/:userId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "email": "email",
  "walletAddress": "walletAddress",
  "userName": "userName",
  "language": "language",
  "countryCode": "BR"
}'

Example Request Body

{
  "email": "email",
  "walletAddress": "walletAddress",
  "userName": "userName",
  "language": "language",
  "countryCode": "BR"
}

json

Example Responses

{
  "data": {
    "userId": "userId",
    "email": "email",
    "walletAddress": "walletAddress",
    "userName": "userName",
    "language": "language",
    "avatar": "avatar",
    "status": "basic",
    "countryCode": "countryCode",
    "kycLevel": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

application/json

S2S Partners S2S Portfolio

List the partner users

GET

https://stg-s2s.restake.gg

/api/v1/s2s/users

Newest first. Optionally narrowed by status or a search term.

List the partner users › query Parameters

page

number

Default: 1

pageSize

number

Items per page, capped at 100.

Default: 20

List the partner users › Responses

Newest first.

S2sUserView[] · required

page

number · required

1-based index of this page.

pageSize

number · required

total

number · required

Rows matching the query, across every page.

Create a user

POST

https://stg-s2s.restake.gg

/api/v1/s2s/users

The user is owned by the calling partner. email is required and must be unique across the whole platform, as must walletAddress when given.

Create a user › Request Body

CreateS2sUserDto

email

string · required

Unique across all users. Stored lowercased.

Example: [email protected]

walletAddress

string

EVM address, unique across all users. Stored lowercased. Optional: an account may be created without one and link it later, once.

Example: 0x1234567890abcdef1234567890abcdef12345678

userName

string

language

string

BCP 47 tag (en, pt-BR). Defaults to en.

Default: en

countryCode

string

ISO 3166-1 alpha-2. Must be a country the platform knows.

Example: BR

Create a user › Responses

S2sUserView · required

Close a user

DELETE

https://stg-s2s.restake.gg

/api/v1/s2s/users/{userId}

Moves the account to closed instead of deleting the row — a user is referenced by sessions, portfolio history and referrals, which must survive. Idempotent.

Close a user › path Parameters

userId

string · required

Close a user › Responses

S2sUserDeletedResponse · required

Update a user

PATCH

https://stg-s2s.restake.gg

/api/v1/s2s/users/{userId}

Omitted fields are left untouched. A wallet address can be set once and is never replaced.

Update a user › path Parameters

userId

string · required

Update a user › Request Body

UpdateS2sUserDto

email

string

Must stay unique.

walletAddress

string

Only settable while the user has no wallet — an existing one is never replaced.

userName

string

language

string

countryCode

string

Update a user › Responses

S2sUserView · required