LogoLogo
  • 🚀DeSo Vision
  • 🪙DeSo Tokenomics
    • No Equity, Just Coins and Code
    • Current DESO Supply
    • Initial DESO Distribution
    • DESO Sinks
    • The BMF: Burn-Maximizing Fee Mechanism
    • Designed for the End-Game
  • 🏛️DeSo Governance
  • ⭐DeSo Tutorial (Build Apps)
  • 🖥️Node Architecture Overview
    • Setup a Node & Frontend Locally
    • Making Your First Changes
  • 📅DeSo Roadmap
  • 🔍DeSo Block Explorer
  • 💸DeSo Wallet
  • 💬DeSo Chat Protocol
  • 👽Openfund
  • 👀Focus
  • 🛠️DeSo Tech Stack
  • 🌐DeSo Applications
  • DeSo Blockchain
    • 1️⃣Bare Metal
    • 2️⃣Scaling Roadmap
    • 3️⃣Content Moderation
    • 4️⃣Infinite-State
    • 5️⃣On-Chain Data
    • 6️⃣Smart Services
    • 7️⃣User Security
  • DeSo Features
    • 1️⃣Associations
    • 2️⃣Creator Coins
    • 3️⃣Feeds & Moderation
    • 4️⃣Social NFTs
    • 5️⃣Social Tipping
  • DeSo Identity
    • 1️⃣Identity: Overview
      • Core Concepts
      • Mobile Integration
    • 2️⃣Identity: iFrame API
      • Overview
      • Endpoints
    • 3️⃣Identity: Window API
      • Overview
      • Endpoints
  • DESO FRONTEND
    • 1️⃣Frontend: Get Started
    • 2️⃣Frontend: React Example
  • DESO BACKEND
    • 1️⃣Backend: Config
      • Onboarding
      • Phone Number Verification
      • Global State
      • Admins
      • Web Security
      • Media
        • Images
        • Videos
      • Hot Feed
      • Selling $DESO
        • Wyre - Buy with USD
        • Buy with BTC
        • Buy with ETH
      • Analytics
      • Emails
      • Supply Monitoring
    • 2️⃣Construct: API
      • Social Transactions API
      • NFT Transactions API
      • Financial Transactions API
      • Derived Keys Transaction API
      • DeSo Tokens Transactions API
      • Associations Transactions API
      • Access Groups API
    • 3️⃣Data: API
      • Admin Endpoints
      • Associations Endpoints
      • DeSo Tokens Endpoints
      • Media Endpoints
      • Miner Endpoints
      • Notification Endpoints
      • NFT Endpoints
      • Social Endpoints
      • Referral Endpoints
      • Tutorial Endpoints
      • Meta Data Endpoints
      • Transaction Spending Limits Endpoints
      • User Endpoints
      • Post Endpoints
      • Messages Endpoints
      • Access Group Endpoints
    • 4️⃣Transactions: API
  • DeSo Exchange Listings
    • 1️⃣Exchange Listing: API
  • DeSo Nodes
    • 2️⃣Node: Setup
    • 3️⃣Node: Staying Up-To-Date
    • 4️⃣Node: FAQ
  • DESO VALIDATORS
    • 1️⃣Run a Validator
  • Openfund
    • What is Openfund?
    • Openfund Tokenomics
    • Openfund Governance
    • Algorithmic Trading
      • The DeSo Python SDK
    • The DeSo Python SDK
      • Getting Help from the Community
      • Creating DeSo Testnet Accounts
      • Debugging Tips and Code Walkthrough
      • Write Blockchain Bots with AI
      • Market-Making Bots
      • Social AI Agents
      • AI-Generating Your Code
    • How Do the Advanced AMMs Work?
  • Focus
    • The Crypto Social Network
    • Next-Generation Token Mechanics
      • Launching Your Token
      • How the Order-Book AMMs Work
    • Crypto-Native Monetization
    • Focus Tokenomics
    • The Social Airdrop
    • Decentralizing Social Media
  • Contact And Media
    • ☀️DeSo Website
    • 📑DeSo Blog
    • 💻DeSo Github
    • 💎DeSo Diamond
    • 🐦DeSo Twitter
    • 📺DeSo YouTube
    • 📬Contact US
    • ⚠️Reporting an Account or Post
  • 中文
    • 什么是DeSo? (What is DeSo?)
    • 愿景 (The Vision)
Powered by GitBook
On this page
  • Get Tutorial Creators
  • Start Or Skip Tutorial
  • Update Tutorial Status

Was this helpful?

  1. DESO BACKEND
  2. Data: API

Tutorial Endpoints

Description of endpoints used to get data related to tutorials on the DeSo blockchain

PreviousReferral EndpointsNextMeta Data Endpoints

Last updated 2 years ago

Was this helpful?

Please make sure you've read Data: API so you are familiar with the following types referenced in this documentation:

Get Tutorial Creators

POST POST /api/v0/get-tutorial-creators

Get the well-known and up-and-coming creators featured in the Buy a Creator step of the tutorial. Creators who have a founder's reward greater than 10% are excluded here.

Endpoint implementation in .

Example usage in frontend: - Make request to - Use GetTutorialCreators to

Request Body

Name
Type
Description

ResponseLimit*

int

Number of creators to return for each category

{
  "WellKnownProfileEntryResponses": [<ProfileEntryResponse>, <ProfileEntryResponse>...], // ProfileEntryResponses of creators randomly selected from the Well-Known category
  "UpAndComingProfileEntryResponses": [<ProfileEntryResponse>, <ProfileEntryResponse>...], // ProfileEntryResponses of creators randomly selected from Up-And-Coming category
}

...coming soon! See comments in sample response for descriptions for now.

{
    // Response
}

Start Or Skip Tutorial

POST /api/v0/start-or-skip-tutorial

Begin or skip the tutorial.

Request Body

Name
Type
Description

PublicKeyBase58Check*

string

Public key of user starting or skipping tutorial

JWT*

string

JSON web token authenticating user

IsSkip

boolean

if true, update the user's tutorial status to skipped. Otherwise, set the tutorial status to started

No response body

{
    // Response
}

Update Tutorial Status

POST /api/v0/update-tutorial-status

Override endpoint to automatically update a user's tutorial status

Valid values for tutorial status are TutorialStarted, TutorialSkipped, InvestInOthersBuyComplete, InvestInOthersSellComplete, TutorialCreateProfileComplete, InvestInYourselfComplete, FollowCreatorsComplete, GiveADiamondComplete, TutorialComplete

Request Body

Name
Type
Description

PublicKeyBase58Check*

string

Public key of user whose tutorial status is being updated

JWT*

string

JSON web token authenticating user

TutorialStatus*

string

Value to be set for user's Tutorial status.

CreatorPurchasedInTutorialPublicKey

string

Public key of creator the well-known or up-and-coming the user purchased in the tutorial

ClearCreatorCoinPurchasedInTutorial

boolean

If true, sets the user's CreatorCoinsPurchasedInTutorial to 0

No response body.

{
    // Response
}

Endpoint implementation in .

Example usages in frontend: - Make request to - Use StartOrSkipTutorial to

Endpoint implementation in .

Example usages in 's frontend: - Make request to - Use UpdateTutorialStatus to

3️⃣
backend
Start Or Skip Tutorial
send user into tutorial or skip
backend
diamondapp.com
Update Tutorial Status
set the user's tutorial status to the current step in your tutorial
backend
Get Tutorial Creators
display creators to the user when they are prompted to buy well-known or up-and-coming creators in the tutorial
ProfileEntryResponse
PostEntryResponse
BalanceEntryResponse
NFTEntryResponse
NFTCollectionResponse