Upland User Information

Endpoints to retrieve Upland Users information.

API Definitions

You must provide a Code to your users generated across the endpoint /auth/opt/init. When Upland User grants access to the developer App, a webhook will be sent with a valid access token. Click here to check the authentication session.

Retrieve user profile information

GET/user/profile

Authorization

bearer

Response

200

Body

application/json

id*string

User Id

eosId*string

Eos Id

username*string

Username

networth*number

Networth

level*enum

Level

VisitorUplanderProDirectorExecutiveChief Executive

avatarUrl*string

Avatar Url

initialCity*string

Initial city

currentCity*string

Current city

isInJail*boolean

Indicates if the user is in jail

Request

JavaScriptCurlPython

const response = await fetch('/user/profile', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "id": "2da598ba-0abb-44f9-bb30-86416af16a20",
  "eosId": "1df22sd3",
  "username": "any_username",
  "networth": 104927.65,
  "level": "Visitor",
  "avatarUrl": "https://any-url.upland.me",
  "initialCity": "San Francisco",
  "currentCity": "San Francisco",
  "isInJail": false
}

List User's NFTs given a category

GET/user/assets/nfts

Authorization

bearer

Query parameters

Response

200

Body

application/json

currentPage*number

Current page

pageSize*number

Total returned per page

totalResults*number

Total of results

results*array of NftResponse (object)

List of User's nfts

Request

JavaScriptCurlPython

const response = await fetch('/user/assets/nfts?currentPage=0&pageSize=0', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "currentPage": 1,
  "pageSize": 10,
  "totalResults": 2,
  "results": [
    {
      "id": 1234,
      "category": "blkexplorer",
      "name": "townhouse",
      "rarityLevel": "townhouse",
      "thumbnail": "https://any-url.upland.me",
      "mintNumber": 0
    }
  ]
}

Retrieve user balances as UPX and SPARK

GET/user/balances

Authorization

bearer

Response

200

Body

application/json

availableUpx*number

Amount of available UPX

availableSpark*number

Amount of available SPARKs

stakedSpark*number

Amount of staked SPARKs

availableSends*number

Amount of available Sends

Request

JavaScriptCurlPython

const response = await fetch('/user/balances', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "availableUpx": 130646,
  "availableSpark": 2.5,
  "stakedSpark": 1.2,
  "availableSends": 0
}

List User's properties

GET/user/assets/properties

Authorization

bearer

Query parameters

Response

200

Body

application/json

currentPage*number

Current page

pageSize*number

Total returned per page

totalResults*number

Total of results

results*array of PropertyResponse (object)

List of properties

Request

JavaScriptCurlPython

const response = await fetch('/user/assets/properties?currentPage=0&pageSize=0', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "currentPage": 1,
  "pageSize": 10,
  "totalResults": 2,
  "results": [
    {
      "id": 55334346,
      "address": "1467 28TH AVE",
      "city": "San Francisco",
      "neighborhood": {
        "id": 798785521654878,
        "name": "ALAMO SQUARE"
      }
    }
  ]
}