GET
/
v1
/
learning
/
student
/
home
TypeScript client
import { TxAgentKitClient } from '@tx-agent-kit/sdk'

const client = new TxAgentKitClient({
  token: process.env.TX_AGENT_KIT_TOKEN
})

const response = await client.studentExperience.getStudentExperienceHome()
{
  "paths": [
    {
      "title": "<string>",
      "backdrop": "<string>",
      "completed": 1,
      "total": 1,
      "islands": [
        {
          "lessonId": "<string>",
          "title": "<string>",
          "topicId": "<string>",
          "position": 1,
          "chapter": "<string>",
          "sessionId": "<string>"
        }
      ]
    }
  ],
  "wallet": {
    "balance": 1,
    "earned": 1,
    "spent": 1
  },
  "streak": 1,
  "mascot": [
    {
      "id": "<string>",
      "name": "<string>",
      "price": 1,
      "appearance": "<string>",
      "owned": true,
      "equipped": true
    }
  ],
  "rollout": {
    "shellEnabled": true,
    "runtimeEnabled": true
  },
  "continuations": [
    {
      "kind": "student_session",
      "id": "<string>",
      "lessonId": "<string>",
      "title": "<string>"
    }
  ]
}

Response

Success

paths
object[]
required
wallet
object
required
streak
integer
required

a non-negative number

Required range: x >= 0
mascot
object[]
required
characterId
enum<string> | null
Available options:
cub,
fox,
rabbit,
clover,
fable
rollout
object
continuations
object[]