LogoLogo
About Us
  • PLAYING THE SANDBOX
    • Get Started
    • Sandbox - Upland Sign Up
    • Buying Upx
  • Sign Up & Authentication
    • 1. Developer's Sign Up
    • 2. Connecting Upland Account
  • Application Management
    • Third-Party Applications
      • Device Checking
    • Inactivating an Application
    • Activating an Application
    • Dev Shops
    • Permission Delegation
  • API Definitions
    • API Information - Sandbox
    • API Information - Production
    • Upland Users Authentication
    • Upland User Information
    • Escrow Container Management
    • Tournament APIs
    • Generic Endpoints
    • Webhooks Notifications
    • Upland Appchain
  • Release Notes
    • September - 21st
    • August - 23rd
    • August - 10th
    • July - 10th
    • July - 3rd
    • April - 27th
    • April - 13th
    • April - 6th
Powered by GitBook
On this page
  1. API Definitions

Upland User Information

Endpoints to retrieve Upland Users information.

PreviousUpland Users AuthenticationNextEscrow Container Management

Last updated 2 years ago

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. to check the authentication session.

Click here

Retrieve user profile information

get
Authorizations
Responses
200Success
application/json
get
GET /user/profile HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "id": "text",
  "eosId": "text",
  "username": "text",
  "networth": 1,
  "level": "Visitor",
  "avatarUrl": "text",
  "initialCity": "text",
  "currentCity": "text",
  "isInJail": true
}

List User's NFTs given a category

get
Authorizations
Query parameters
currentPagenumberRequired
pageSizenumberRequired
Responses
200Success
application/json
get
GET /user/assets/nfts?currentPage=1&pageSize=1 HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "currentPage": 1,
  "pageSize": 1,
  "totalResults": 1,
  "results": [
    {
      "id": 1,
      "category": "blkexplorer",
      "name": "text",
      "rarityLevel": "text",
      "thumbnail": "text",
      "mintNumber": 1
    }
  ]
}

Retrieve user balances as UPX and SPARK

get
Authorizations
Responses
200Success
application/json
get
GET /user/balances HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "availableUpx": 1,
  "availableSpark": 1,
  "stakedSpark": 1,
  "availableSends": 1
}

List User's properties

get
Authorizations
Query parameters
currentPagenumberRequired
pageSizenumberRequired
Responses
200Success
application/json
get
GET /user/assets/properties?currentPage=1&pageSize=1 HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "currentPage": 1,
  "pageSize": 1,
  "totalResults": 1,
  "results": [
    {
      "id": 1,
      "address": "text",
      "city": "text",
      "neighborhood": {
        "id": 1,
        "name": "text"
      }
    }
  ]
}
  • API Definitions
  • GETRetrieve user profile information
  • GETList User's NFTs given a category
  • GETRetrieve user balances as UPX and SPARK
  • GETList User's properties