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

Authorizations

AuthorizationstringRequired

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

Responses

200Success

application/json

idstringRequired

User Id

Default: 2da598ba-0abb-44f9-bb30-86416af16a20

eosIdstringRequired

Eos Id

Default: 1df22sd3

usernamestringRequired

Username

Default: any_username

networthnumberRequired

Networth

Default: 104927.65

levelstring · enumRequired

Level

Default: ProPossible values:

avatarUrlstringRequired

Avatar Url

Default: https://any-url.upland.me

initialCitystringRequired

Initial city

Default: San Francisco

currentCitystringRequired

Current city

Default: San Francisco

isInJailbooleanRequired

Indicates if the user is in jail

Default: false

get/user/profile

GET /user/profile HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

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

List User's NFTs given a category

get

Authorizations

AuthorizationstringRequired

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

Query parameters

currentPagenumberRequired

pageSizenumberRequired

Responses

200Success

application/json

currentPagenumberRequired

Current page

Default: 1

pageSizenumberRequired

Total returned per page

Default: 10

totalResultsnumberRequired

Total of results

Default: 2

get/user/assets/nfts

GET /user/assets/nfts?currentPage=1&pageSize=1 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "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

Authorizations

AuthorizationstringRequired

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

Responses

200Success

application/json

availableUpxnumberRequired

Amount of available UPX

Default: 130646

availableSparknumberRequired

Amount of available SPARKs

Default: 2.5

stakedSparknumberRequired

Amount of staked SPARKs

Default: 1.2

availableSendsnumberRequired

Amount of available Sends

Default: 0

get/user/balances

GET /user/balances HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

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

List User's properties

get

Authorizations

AuthorizationstringRequired

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

Query parameters

currentPagenumberRequired

pageSizenumberRequired

Responses

200Success

application/json

currentPagenumberRequired

Current page

Default: 1

pageSizenumberRequired

Total returned per page

Default: 10

totalResultsnumberRequired

Total of results

Default: 2

get/user/assets/properties

GET /user/assets/properties?currentPage=1&pageSize=1 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

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