Users service

The Users Service API provides various endpoints for managing user-related functionalities, including user authentication, profile management, and account operations. With this API, you can create, authenticate, update, and delete user accounts, as well as perform actions such as logging in, logging out, and adding new addresses to existing accounts. Additionally, you can retrieve user data, check username availability, and search for users and public profiles. This API empowers you to build user-centric applications and interact with user-related data efficiently.

Swagger docs link :

https://api.metaproprotocol.com/users-service/docs/#/

Returns user data

Only for logged in

POST..//internal/users

Authorization

Header parameters

Body

addresses*array of Wallet (object)

Response

Body

userId*string

addresses*array of Wallet (object)

Request

const response = await fetch('..//internal/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "addresses": [
        {
          "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
        }
      ]
    }),
});
const data = await response.json();

Response

[
  {
    "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
    "addresses": [
      {
        "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
      }
    ]
  }
]

Logs user in and returns his data

POST..//auth/login

Header parameters

Body

wallet*string

signature*string

Alphanumeric values

Response

Body

token*object

account*UserEntity (object)

Request

const response = await fetch('..//auth/login', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62",
      "signature": "0xb91467e570a6466aa9e9876cbcd013baba02900b8979d43fe208a4a4f339f5fd6007e74cd82e037b800186422fc2da167c747ef045e5d18a5f5d4300f8e1a0291c"
    }),
});
const data = await response.json();

Response

{
  "token": {
    "accessToken": "text",
    "tokenType": "text"
  },
  "account": {
    "id": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
    "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
    "elympicsUserId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
    "addresses": [
      {
        "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
      }
    ],
    "socialMedia": [
      {
        "name": "steam",
        "value": "https://steam.com/my-account",
        "createdAt": "2022-05-25T16:17:01.797Z",
        "updatedAt": "2022-05-25T16:17:01.797Z"
      }
    ],
    "externalAccounts": [
      {
        "name": "steam",
        "createdAt": "2022-05-25T16:17:01.797Z",
        "updatedAt": "2022-05-25T16:17:01.797Z"
      }
    ],
    "rulesCheckbox": {
      "checked": false,
      "updatedAt": "2022-05-25T16:17:01.797Z"
    },
    "personalDetails": {
      "email": "email@test.com",
      "username": "johny_bravo",
      "country": "PL",
      "firstName": "Adam",
      "lastName": "Kowalski",
      "birthDate": "2022-05-25T16:17:01.797Z",
      "bio": "Some text about me",
      "avatar": "qwer-qwer-qwer-qwer.png",
      "banner": "fda-fda-fdsa-fdas.jpg",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    },
    "engagementPoints": 0,
    "visitedAt": "2022-05-25T16:17:01.797Z",
    "createdAt": "2022-05-25T16:17:01.797Z",
    "updatedAt": "2022-05-25T16:17:01.797Z"
  }
}

Add a new address (from different chain) to an existing BSC account

POST..//auth/new-address

Authorization

Header parameters

Body

wallet*string

mergeboolean

confirmation of merge wallet with existing wallet

Response

Body

id*string

userId*string

elympicsUserId*string

role*enum

addresses*array of Wallet (object)

socialMediaarray of SocialMedia (object)

externalAccountsarray of ExternalAccount (object)

rulesCheckboxRulesCheckbox (object)

personalDetailsPersonalDetails (object)

engagementPointsnumber

visitedAtstring (date-time)

createdAt*string (date-time)

updatedAt*string (date-time)

Request

const response = await fetch('..//auth/new-address', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
    }),
});
const data = await response.json();

Response

{
  "id": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "elympicsUserId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "addresses": [
    {
      "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
    }
  ],
  "socialMedia": [
    {
      "name": "steam",
      "value": "https://steam.com/my-account",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "externalAccounts": [
    {
      "name": "steam",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "rulesCheckbox": {
    "checked": false,
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "personalDetails": {
    "email": "email@test.com",
    "username": "johny_bravo",
    "country": "PL",
    "firstName": "Adam",
    "lastName": "Kowalski",
    "birthDate": "2022-05-25T16:17:01.797Z",
    "bio": "Some text about me",
    "avatar": "qwer-qwer-qwer-qwer.png",
    "banner": "fda-fda-fdsa-fdas.jpg",
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "engagementPoints": 0,
  "visitedAt": "2022-05-25T16:17:01.797Z",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z"
}

Logs user out

POST..//auth/logout

Authorization

Header parameters

Response

Request

const response = await fetch('..//auth/logout', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Returns login hash

GET..//auth/signature/hash

Header parameters

Response

Body

hash*string

Request

const response = await fetch('..//auth/signature/hash', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "hash": "text"
}

Returns user data

Only for logged in

GET..//me

Authorization

Header parameters

Response

Body

id*string

userId*string

elympicsUserId*string

role*enum

addresses*array of Wallet (object)

socialMediaarray of SocialMedia (object)

externalAccountsarray of ExternalAccount (object)

rulesCheckboxRulesCheckbox (object)

personalDetailsPersonalDetails (object)

engagementPointsnumber

visitedAtstring (date-time)

createdAt*string (date-time)

updatedAt*string (date-time)

Request

const response = await fetch('..//me', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "elympicsUserId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "addresses": [
    {
      "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
    }
  ],
  "socialMedia": [
    {
      "name": "steam",
      "value": "https://steam.com/my-account",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "externalAccounts": [
    {
      "name": "steam",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "rulesCheckbox": {
    "checked": false,
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "personalDetails": {
    "email": "email@test.com",
    "username": "johny_bravo",
    "country": "PL",
    "firstName": "Adam",
    "lastName": "Kowalski",
    "birthDate": "2022-05-25T16:17:01.797Z",
    "bio": "Some text about me",
    "avatar": "qwer-qwer-qwer-qwer.png",
    "banner": "fda-fda-fdsa-fdas.jpg",
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "engagementPoints": 0,
  "visitedAt": "2022-05-25T16:17:01.797Z",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z"
}

Checks username availability

Only for logged in

GET..//availability/{username}

Authorization

Path parameters

username*string

Header parameters

Response

Body

isAvailable*boolean

Request

const response = await fetch('..//availability/{username}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "isAvailable": false
}

Returns public user data

GET..//profile/{user}

Path parameters

user*string

Response

Body

id*string

userId*string

elympicsUserId*string

role*enum

addresses*array of Wallet (object)

socialMediaarray of SocialMedia (object)

externalAccountsarray of ExternalAccount (object)

rulesCheckboxRulesCheckbox (object)

personalDetailsPersonalDetails (object)

engagementPointsnumber

visitedAtstring (date-time)

createdAt*string (date-time)

updatedAt*string (date-time)

Request

const response = await fetch('..//profile/{user}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "elympicsUserId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "addresses": [
    {
      "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
    }
  ],
  "socialMedia": [
    {
      "name": "steam",
      "value": "https://steam.com/my-account",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "externalAccounts": [
    {
      "name": "steam",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "rulesCheckbox": {
    "checked": false,
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "personalDetails": {
    "email": "email@test.com",
    "username": "johny_bravo",
    "country": "PL",
    "firstName": "Adam",
    "lastName": "Kowalski",
    "birthDate": "2022-05-25T16:17:01.797Z",
    "bio": "Some text about me",
    "avatar": "qwer-qwer-qwer-qwer.png",
    "banner": "fda-fda-fdsa-fdas.jpg",
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "engagementPoints": 0,
  "visitedAt": "2022-05-25T16:17:01.797Z",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z"
}

Returns list of users

GET..//profiles

Query parameters

Response

Body

results*array of UserEntity (object)

count*number

Request

const response = await fetch('..//profiles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "results": [
    {
      "id": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
      "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
      "elympicsUserId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
      "addresses": [
        {
          "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
        }
      ],
      "socialMedia": [
        {
          "name": "steam",
          "value": "https://steam.com/my-account",
          "createdAt": "2022-05-25T16:17:01.797Z",
          "updatedAt": "2022-05-25T16:17:01.797Z"
        }
      ],
      "externalAccounts": [
        {
          "name": "steam",
          "createdAt": "2022-05-25T16:17:01.797Z",
          "updatedAt": "2022-05-25T16:17:01.797Z"
        }
      ],
      "rulesCheckbox": {
        "checked": false,
        "updatedAt": "2022-05-25T16:17:01.797Z"
      },
      "personalDetails": {
        "email": "email@test.com",
        "username": "johny_bravo",
        "country": "PL",
        "firstName": "Adam",
        "lastName": "Kowalski",
        "birthDate": "2022-05-25T16:17:01.797Z",
        "bio": "Some text about me",
        "avatar": "qwer-qwer-qwer-qwer.png",
        "banner": "fda-fda-fdsa-fdas.jpg",
        "updatedAt": "2022-05-25T16:17:01.797Z"
      },
      "engagementPoints": 0,
      "visitedAt": "2022-05-25T16:17:01.797Z",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "count": 0
}

Returns a list of requested Users

GET..//users-search/{searchText}

Path parameters

searchText*string

Query parameters

Response

Body

results*array of UserEntity (object)

count*number

Request

const response = await fetch('..//users-search/{searchText}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "results": [
    {
      "id": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
      "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
      "elympicsUserId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
      "addresses": [
        {
          "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
        }
      ],
      "socialMedia": [
        {
          "name": "steam",
          "value": "https://steam.com/my-account",
          "createdAt": "2022-05-25T16:17:01.797Z",
          "updatedAt": "2022-05-25T16:17:01.797Z"
        }
      ],
      "externalAccounts": [
        {
          "name": "steam",
          "createdAt": "2022-05-25T16:17:01.797Z",
          "updatedAt": "2022-05-25T16:17:01.797Z"
        }
      ],
      "rulesCheckbox": {
        "checked": false,
        "updatedAt": "2022-05-25T16:17:01.797Z"
      },
      "personalDetails": {
        "email": "email@test.com",
        "username": "johny_bravo",
        "country": "PL",
        "firstName": "Adam",
        "lastName": "Kowalski",
        "birthDate": "2022-05-25T16:17:01.797Z",
        "bio": "Some text about me",
        "avatar": "qwer-qwer-qwer-qwer.png",
        "banner": "fda-fda-fdsa-fdas.jpg",
        "updatedAt": "2022-05-25T16:17:01.797Z"
      },
      "engagementPoints": 0,
      "visitedAt": "2022-05-25T16:17:01.797Z",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "count": 0
}

Remove a wallet from user account

This endpoint doesn't delete account, just remove a wallet (different than currently logged in)

DELETE..//auth/remove/{wallet}

Authorization

Path parameters

wallet*string

Header parameters

Response

Body

id*string

userId*string

elympicsUserId*string

role*enum

addresses*array of Wallet (object)

socialMediaarray of SocialMedia (object)

externalAccountsarray of ExternalAccount (object)

rulesCheckboxRulesCheckbox (object)

personalDetailsPersonalDetails (object)

engagementPointsnumber

visitedAtstring (date-time)

createdAt*string (date-time)

updatedAt*string (date-time)

Request

const response = await fetch('..//auth/remove/{wallet}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "elympicsUserId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "addresses": [
    {
      "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
    }
  ],
  "socialMedia": [
    {
      "name": "steam",
      "value": "https://steam.com/my-account",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "externalAccounts": [
    {
      "name": "steam",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "rulesCheckbox": {
    "checked": false,
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "personalDetails": {
    "email": "email@test.com",
    "username": "johny_bravo",
    "country": "PL",
    "firstName": "Adam",
    "lastName": "Kowalski",
    "birthDate": "2022-05-25T16:17:01.797Z",
    "bio": "Some text about me",
    "avatar": "qwer-qwer-qwer-qwer.png",
    "banner": "fda-fda-fdsa-fdas.jpg",
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "engagementPoints": 0,
  "visitedAt": "2022-05-25T16:17:01.797Z",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z"
}

Delete an existing account

DELETE..//auth/delete/account

Authorization

Header parameters

Response

Request

const response = await fetch('..//auth/delete/account', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Add a new address to an existing account

PATCH..//update

Authorization

Header parameters

Body

socialMedia*array of SocialMediaDto (object)

personalDetails*PersonalDetailsDto (object)

elympicsUserId*string

rulesCheckbox*RulesCheckbox (object)

Response

Body

id*string

userId*string

elympicsUserId*string

role*enum

addresses*array of Wallet (object)

socialMediaarray of SocialMedia (object)

externalAccountsarray of ExternalAccount (object)

rulesCheckboxRulesCheckbox (object)

personalDetailsPersonalDetails (object)

engagementPointsnumber

visitedAtstring (date-time)

createdAt*string (date-time)

updatedAt*string (date-time)

Request

const response = await fetch('..//update', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "socialMedia": [
        {
          "name": "steam",
          "value": "https://steam.com/my-account"
        }
      ],
      "personalDetails": {
        "email": "email@test.com",
        "country": "PL",
        "firstName": "Adam",
        "lastName": "Kowalski",
        "birthDate": "2022-05-25T16:17:01.797Z",
        "bio": "Some text about me",
        "avatar": "qwer-qwer-qwer-qwer.png",
        "banner": "fda-fda-fdsa-fdas.jpg"
      },
      "elympicsUserId": "text",
      "rulesCheckbox": {
        "checked": false,
        "updatedAt": "2022-05-25T16:17:01.797Z"
      }
    }),
});
const data = await response.json();

Response

{
  "id": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "userId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "elympicsUserId": "572843fa-9eb3-45d6-82ba-33ba5b4406c7",
  "addresses": [
    {
      "wallet": "0xdd094342c13F9E4340E2c07C63D9fD98e7BA1C62"
    }
  ],
  "socialMedia": [
    {
      "name": "steam",
      "value": "https://steam.com/my-account",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "externalAccounts": [
    {
      "name": "steam",
      "createdAt": "2022-05-25T16:17:01.797Z",
      "updatedAt": "2022-05-25T16:17:01.797Z"
    }
  ],
  "rulesCheckbox": {
    "checked": false,
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "personalDetails": {
    "email": "email@test.com",
    "username": "johny_bravo",
    "country": "PL",
    "firstName": "Adam",
    "lastName": "Kowalski",
    "birthDate": "2022-05-25T16:17:01.797Z",
    "bio": "Some text about me",
    "avatar": "qwer-qwer-qwer-qwer.png",
    "banner": "fda-fda-fdsa-fdas.jpg",
    "updatedAt": "2022-05-25T16:17:01.797Z"
  },
  "engagementPoints": 0,
  "visitedAt": "2022-05-25T16:17:01.797Z",
  "createdAt": "2022-05-25T16:17:01.797Z",
  "updatedAt": "2022-05-25T16:17:01.797Z"
}

PreviousAPI NextTeams service

Last updated 5 months ago