Skip to main content

Public API Endpoints

Glow Prow provides standardized RESTful APIs for developers and community tools, supporting ship assemblies, Twitch drops, territory war state, map collections, and user data.

Overview​

Base URL​

All public API requests should be sent to:

https://api.glow-prow.top/api/

Authentication​

  • Public Endpoints: Can be called directly without authentication headers.
  • User-Specific Endpoints: Require a valid bearer token in the HTTP Authorization header: 
    Authorization: Bearer <your_access_token>

Standard Response Envelope​

{
  "code": 200,
  "message": "success",
  "data": {}
}

Ship Assembly APIs​

Endpoints for creating, querying, updating, and calculating ship loadout configurations.

Get Public Assembly List​

  • Method: GET /assembly/list
  • Auth: Public
  • Query Parameters:
    • page (number, optional): Page number, default 1
    • pageSize (number, optional): Page size, default 20
    • keyword (string, optional): Search keyword for title or tags
    • shipType (string, optional): Filter by target ship type
    • sort (string, optional): Sort criteria (latest, hottest, rating)

Get Assembly Details​

  • Method: GET /assembly/item
  • Auth: Public (Password required for private assemblies)
  • Query Parameters:
    • uuid (string, required): 36-character assembly UUID
    • password (string, optional): Access password for protected builds
    • force (boolean, optional): Force cache refresh

Publish New Assembly​

  • Method: POST /assembly/publish
  • Auth: User Token required
  • Body Parameters:
    • name (string, required): Loadout name
    • shipId (string, required): Ship hull ID
    • weapons (array, required): Weapon slot items
    • armor (string, optional): Armor item ID
    • furnitures (array, optional): Furniture module list
    • isPublic (boolean, optional): Publicly discoverable, default true

Edit Assembly​

  • Method: POST /assembly/edit
  • Auth: User Token required (creator only)
  • Body Parameters:
    • uuid (string, required): Assembly UUID
    • data (object, required): Updated loadout payload

Delete Assembly​

  • Method: POST /assembly/delete
  • Auth: User Token required (moves to trash)
  • Body Parameters:
    • uuid (string, required): Assembly UUID

Get Assembly Attributes​

  • Method: GET /assembly/attr
  • Auth: Public
  • Query Parameters:
    • uuid (string, required): Assembly UUID

Trash and Restoration​

  • List Trash Items: GET /assembly/trash (User Token required)
  • Restore Deleted Item: POST /assembly/restore ({ "uuid": "..." })

Twitch Drops APIs​

Provides live and historical Twitch Drops campaign data.

Get Current Active Drops​

  • Method: GET /drop/current
  • Auth: Public
  • Query Parameters:
    • refresh (number, optional): Pass 1 to bypass server cache

Get Historical Drops Archive​

  • Method: GET /drop/history
  • Auth: Public
  • Query Parameters:
    • page (number, optional): Page number, default 1
    • pageSize (number, optional): Page size, default 10
    • status (string, optional): Status filter (active, upcoming, ended)
    • keyword (string, optional): Search keyword

Get Campaign Detail​

  • Method: GET /drop/{id}
  • Auth: Public
  • Path Parameters:
    • id (string/number, required): Drop campaign ID

State of War APIs​

Provides live territory control, company score standings, and historical shift timelines.

Get Latest War State​

  • Method: GET /stateOfWar/latest
  • Auth: Public
  • Returns: Territory control by trading companies, zone scores, and active hotspots

Get Season War State​

  • Method: GET /stateOfWar/season/{season}
  • Auth: Public
  • Path Parameters:
    • season (string/number, required): Season identifier or number

Get Available Seasons​

  • Method: GET /stateOfWar/seasons
  • Auth: Public

Get Historical War Timeline​

  • Method: GET /stateOfWar/history
  • Auth: Public
  • Query Parameters:
    • range (string, optional): Time window (1h, 1d, 7d, default 1d)
    • season (string/number, optional): Target season

Interactive Map APIs​

Provides custom marker collections, points of interest, and map collections.

List User Map Collections​

  • Method: GET /map/collections
  • Auth: User Token required

Get Map Collection Details​

  • Method: GET /map/collection/{uuid}
  • Auth: Public (Private maps require author token)
  • Path Parameters:
    • uuid (string, required): Collection UUID

Create Map Collection​

  • Method: POST /map/collection
  • Auth: User Token required
  • Body Parameters:
    • title (string, required): Collection title
    • description (string, optional): Description
    • points (array, optional): Initial point array

Update & Delete Map Collection​

  • Update: PUT /map/collection/{uuid}
  • Delete: DELETE /map/collection/{uuid}

Subscription & Orders APIs​

Provides community sponsorship plans, progress tracking, and order management.

Get Sponsorship Plans​

  • Method: GET /subscription/plans
  • Auth: Public

Get Monthly Sponsorship Goal Progress​

  • Method: GET /subscription/progress
  • Auth: Public

Get Core Donors Hall of Fame​

  • Method: GET /subscription/hall
  • Auth: Public

Get Current User Membership Status​

  • Method: GET /subscription/my-status
  • Auth: User Token required

Get Current User Orders​

  • Method: GET /subscription/my-orders
  • Auth: User Token required

Create Sponsorship Order​

  • Method: POST /subscription/orders/create
  • Auth: User Token required
  • Body Parameters:
    • tierId (string, required): Tier identifier
    • payType (string, required): Payment gateway method

Cancel Pending Order​

  • Method: POST /subscription/orders/{orderId}/cancel
  • Auth: User Token required

Calendar & Seasons APIs​

Get Season Calendar Timeline​

  • Method: GET /calendar/data
  • Auth: Public
  • Query Parameters:
    • season (string, required): Season identifier

User & Authentication APIs​

User Sign In​

  • Method: POST /user/signin
  • Body Parameters:
    • username (string, required): Username or email
    • password (string, required): Password

User Sign Up​

  • Method: POST /user/signup
  • Body Parameters:
    • username (string, required): Username
    • email (string, required): Email address
    • password (string, required): Password
    • captchaCode (string, optional): Captcha token

Get Current Profile​

  • Method: GET /user/me
  • Auth: User Token required

Get Public Profile by ID​

  • Method: GET /user/info
  • Auth: Public
  • Query Parameters:
    • id (string, required): User UID

Captcha APIs​

Request Human Verification Challenge​

  • Method: GET /captcha
  • Auth: Public