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

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/user/profile' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

List User's NFTs given a category

get

/user/assets/nfts

Authorizations

Query parameters

currentPagenumberrequired

pageSizenumberrequired

categoriesstring · enum[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/user/assets/nfts?currentPage=1&pageSize=1' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "currentPage": 1,
  "pageSize": 10,
  "totalResults": 2,
  "results": [
    {
      "id": 30212,
      "category": "structure",
      "name": "townhouse",
      "thumbnail": "https://any-url.upland.me/small_town_baked.png"
    },
    {
      "id": 30210,
      "category": "structure",
      "name": "townhouse",
      "thumbnail": "https://any-url.upland.me/small_town_baked.png"
    }
  ]
}

Retrieve user balances as UPX and SPARK

get

/user/balances

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/user/balances' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

List User's properties

get

/user/assets/properties

Authorizations

Query parameters

currentPagenumberrequired

pageSizenumberrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/user/assets/properties?currentPage=1&pageSize=1' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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