ℹ️Step 3 - User Account Information

In this Step, we will describe how you can collect the informations linked to the Users through the AccountId or PortfolioId.

1 - This first endpoint will give you the possibility to collect all the data relating to a given User. By entering the UserId, you will access his name, surname, phone, email, AccountId, SubAccountId, PortfolioId and any other information you may have inserted.

GET/v1/user/me

Response

200

OK

Body

*/*

successboolean

dataUserAccountView (object)

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

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

Response

{
  "success": false,
  "data": {
    "userId": "text",
    "phoneNumber": "text",
    "name": "text",
    "surname": "text",
    "accounts": [
      {
        "accountId": "text",
        "email": "text",
        "subAccountId": "text",
        "subAccountEmail": "text",
        "encryptionKey": "text",
        "creationTs": "2024-07-27T08:18:11.308Z",
        "portfolios": [
          {
            "portfolioId": "text",
            "name": "text",
            "accountId": "text",
            "creationTs": "2024-07-27T08:18:11.308Z",
            "publicStrategy": false,
            "portfolioAccountType": "TRADING"
          }
        ],
        "active": false,
        "tradingPortfolioId": "text"
      }
    ],
    "kycIds": [
      "text"
    ],
    "documentIds": [
      "text"
    ],
    "email": "text",
    "userAccountStatus": "text"
  },
  "errorMessage": "text"
}

OAuth: user_auth

2 - With this second endpoint, you will be able to collect of the information related to an AccountId: email, AccountId, SubAccountId, PortfolioId and any other information you may have inserted.

GET/v1/account/{accountId}

Path parameters

accountId*string

Response

200

OK

Body

*/*

successboolean

dataAccount (object)

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

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

Response

{
  "success": false,
  "data": {
    "accountId": "text",
    "email": "text",
    "subAccountId": "text",
    "subAccountEmail": "text",
    "encryptionKey": "text",
    "creationTs": "2024-07-27T08:18:11.308Z",
    "portfolios": [
      {
        "portfolioId": "text",
        "name": "text",
        "accountId": "text",
        "creationTs": "2024-07-27T08:18:11.308Z",
        "publicStrategy": false,
        "portfolioAccountType": "TRADING"
      }
    ],
    "active": false,
    "tradingPortfolioId": "text"
  },
  "errorMessage": "text"
}

OAuth: client_auth

3 - With this endpoint, you will be able to obtain the balance on any AccountId.

GET/v1/account/{accountId}/balance

Path parameters

accountId*string

Response

200

OK

Body

*/*

successboolean

dataGlobalBalanceView (object)

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

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

Response

{
  "success": false,
  "data": {
    "accountId": "text",
    "ts": "2024-07-27T08:18:11.308Z",
    "portfolioBalances": [
      {
        "accountId": "text",
        "portfolioId": "text",
        "portfolioAccountType": "TRADING",
        "ts": "2024-07-27T08:18:11.308Z",
        "assetBalances": [
          {
            "portfolioId": "text",
            "ts": "2024-07-27T08:18:11.308Z",
            "asset": {
              "slug": "text",
              "name": "text",
              "logoUrl": "text",
              "availableNetworks": [
                "text"
              ]
            },
            "quantity": 0,
            "eurValue": 0,
            "usdValue": 0
          }
        ]
      }
    ]
  },
  "errorMessage": "text"
}

OAuth: client_auth

4 - With this endpoint, you will be able to obtain all the information relating to on any PortfolioId.

GET/v1/account/portfolio/{accountId}/{portfolioId}

Path parameters

accountId*string

portfolioId*string

Response

200

OK

Body

*/*

successboolean

dataPortfolio (object)

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

const response = await fetch('/v1/account/portfolio/{accountId}/{portfolioId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "portfolioId": "text",
    "name": "text",
    "accountId": "text",
    "creationTs": "2024-07-27T08:18:11.308Z",
    "publicStrategy": false,
    "portfolioAccountType": "TRADING"
  },
  "errorMessage": "text"
}

OAuth: client_auth