Highrise Auth API

The auth API from Highrise — 8 operation(s) for auth.

Operations 8

POST /api/login Login #
POST /api/login_web Login Web #
POST /api/oauth_login Oauth Login #
GET /api/login_discourse Login Discourse #
POST /api/logout Logout #
POST /api/whoami Whoami #
POST /api/whoami_web Whoami Web #
POST /api/set_email Set Email #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/highrise:highrise-auth-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

highrise-auth-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Create Auth API
  version: '1.0'
tags:
- name: Auth
paths:
  /api/login:
    post:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfo'
      parameters:
      - name: hr_s_production
        in: cookie
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginRequest'
        required: true
      security:
      - cookie/hr_s_production: []
      summary: Login
      tags:
      - Auth
      operationId: login
  /api/login_web:
    post:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfoWeb'
      parameters:
      - name: hr_s_production
        in: cookie
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginRequest'
        required: true
      security:
      - cookie/hr_s_production: []
      summary: Login Web
      tags:
      - Auth
      operationId: login_web
  /api/oauth_login:
    post:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfoWeb'
      parameters:
      - name: hr_s_production
        in: cookie
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OauthLoginRequest'
        required: true
      security:
      - cookie/hr_s_production: []
      summary: Oauth Login
      tags:
      - Auth
      operationId: oauth_login
  /api/login_discourse:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiscourseResponse'
        '400':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - name: sso
        in: query
        required: true
        schema:
          type: string
      - name: sig
        in: query
        required: true
        schema:
          type: string
      - name: user_id
        in: query
        required: true
        schema:
          type: string
      - name: username
        in: query
        required: true
        schema:
          type: string
      - name: email
        in: query
        required: true
        schema:
          type: string
      summary: Login Discourse
      tags:
      - Auth
      operationId: login_discourse
  /api/logout:
    post:
      responses:
        '200':
          description: No content
      parameters:
      - name: hr_s_production
        in: cookie
        schema:
          type: string
      security:
      - cookie/hr_s_production: []
      summary: Logout
      tags:
      - Auth
      operationId: logout
  /api/whoami:
    post:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfo'
        '401':
          description: No content
      parameters:
      - name: hr_s_production
        in: cookie
        schema:
          type: string
      security:
      - cookie/hr_s_production: []
      summary: Whoami
      tags:
      - Auth
      operationId: whoami
  /api/whoami_web:
    post:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfoWeb'
        '401':
          description: No content
      parameters:
      - name: hr_s_production
        in: cookie
        schema:
          type: string
      security:
      - cookie/hr_s_production: []
      summary: Whoami Web
      tags:
      - Auth
      operationId: whoami_web
  /api/set_email:
    post:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetUserEmailResponse'
        '400':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      parameters:
      - name: hr_s_production
        in: cookie
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetUserEmailRequest'
        required: true
      security:
      - cookie/hr_s_production: []
      summary: Set Email
      tags:
      - Auth
      operationId: set_email
components:
  schemas:
    OutfitItemColors:
      type: object
      properties:
        linked_colors:
          type: string
    NFTMetadata:
      type: object
      properties:
        token_id:
          type: string
        contract:
          type: string
      required:
      - token_id
      - contract
    OauthLoginRequest:
      type: object
      properties:
        type:
          type: string
        token:
          type: string
      required:
      - type
      - token
    LoginRequest:
      type: object
      properties:
        username:
          type: string
        password:
          type: string
        totp:
          oneOf:
          - type: string
          - type: 'null'
        hotp:
          oneOf:
          - type: string
          - type: 'null'
        turnstile_token:
          oneOf:
          - type: string
          - type: 'null'
      required:
      - username
      - password
    UserInfo:
      type: object
      properties:
        id:
          type: string
        username:
          type: string
        outfit:
          items:
            $ref: '#/components/schemas/Clothing'
          type: array
        email:
          oneOf:
          - type: string
          - type: 'null'
        privilege_level:
          oneOf:
          - type: string
          - type: 'null'
        avatar_key:
          oneOf:
          - type: string
          - type: 'null'
        icon_key:
          oneOf:
          - type: string
          - type: 'null'
        pet:
          oneOf:
          - $ref: '#/components/schemas/PetInfo'
          - type: 'null'
      required:
      - id
      - username
      - outfit
    DiscourseResponse:
      type: object
      properties:
        redirect_url:
          type: string
      required:
      - redirect_url
    UserInfoWeb:
      type: object
      properties:
        id:
          type: string
        username:
          type: string
        email:
          oneOf:
          - type: string
          - type: 'null'
        privilege_level:
          oneOf:
          - type: string
          - type: 'null'
        avatar_key:
          oneOf:
          - type: string
          - type: 'null'
        icon_key:
          oneOf:
          - type: string
          - type: 'null'
        is_age_verified_above_18:
          type: boolean
      required:
      - id
      - username
    SetUserEmailRequest:
      type: object
      properties:
        email:
          type: string
      required:
      - email
    Clothing:
      type: object
      properties:
        descriptor_id:
          type: string
        active_palette:
          type: integer
        account_bound:
          type: boolean
        nft_metadata:
          oneOf:
          - $ref: '#/components/schemas/NFTMetadata'
          - type: 'null'
        nfi_metadata:
          oneOf:
          - $ref: '#/components/schemas/NFIItemMetadata'
          - type: 'null'
        parts:
          oneOf:
          - type: 'null'
        colors:
          oneOf:
          - $ref: '#/components/schemas/OutfitItemColors'
          - type: 'null'
        selected_style:
          type: integer
      required:
      - descriptor_id
      - active_palette
      - account_bound
      - nft_metadata
      - nfi_metadata
    NFIItemMetadata:
      type: object
      properties:
        stack_id:
          type: string
        item_number:
          type: integer
      required:
      - stack_id
      - item_number
    SetUserEmailResponse:
      type: object
      properties: {}
    Error:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    PetInfo:
      type: object
      properties:
        name:
          type: string
        stack_id:
          type: string
        descriptor_id:
          type: string
        outfit:
          items:
            $ref: '#/components/schemas/Clothing'
          type: array
      required:
      - name
      - stack_id
      - descriptor_id
      - outfit
  securitySchemes:
    cookie_hr_s_production:
      name: hr_s_production
      in: cookie
      description: null
      type: apiKey
x-provenance:
  method: harvested
  publisher: Highrise
  source: https://create.highrise.game/api/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)