Skip to content
GAMPEONCreate
GAMPEON on Discord
New project

Public profile

GET
/v1/profiles/{handle}
curl --request GET \
  --url https://api.gampeon.com/v1/profiles/example

Display name, bio, public marketplace items, servers online, studios, projects and achievements of an account. Never contains the email address.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
handle
required
string
/^[a-z0-9_]{3,24}$/

Handle of the account

Responses

Section titled “Responses”

200

Section titled “200”

Profile

Media typeapplication/json
object
handle
required
string
displayName
required
string
bio
required
string
avatar
required
One of:

Image path relative to the API (/v1/media/…). null without an image.

string
cover
required
One of:

Image path relative to the API (/v1/media/…). null without an image.

string
staff
required

True for moderators and admins

boolean
joinedAt
required

Unix time in milliseconds

integer format: int64
resources
required

Public marketplace items (up to 100)

Array<object>
object
name
required

Unique resource name

string
/^[a-z0-9][a-z0-9_\-]{1,47}$/
title
required
string
description
required
string
kind
required
string
Allowed values: script vehicle map prop clothing gamemode tool
tags
required
Array<string>
owner
required
object
handle
required

Unique handle

string
/^[a-z0-9_]{3,24}$/
displayName
required
string
avatar
One of:

Image path relative to the API (/v1/media/…). null without an image.

string
latestVersion
required
One of:

Newest version that is not blocked

string
image
required
One of:

Path of the preview image, relative to the API, for example /v1/images/<sha256>.webp

string
downloads
required

Downloads of all versions

integer
price
required

Price in GAMPEONS, 0 = free

integer
createdAt
required

Unix time in milliseconds

integer format: int64
updatedAt
required

Unix time in milliseconds

integer format: int64
servers
required

Servers that are online right now

Array<object>
object
id
required

Server ID

string format: uuid
name
required
string
description
required
string
website
required
One of:
string
owner
required
object
handle
required

Unique handle

string
/^[a-z0-9_]{3,24}$/
displayName
required
string
avatar
One of:

Image path relative to the API (/v1/media/…). null without an image.

string
online
required

Sent a heartbeat in the last 90 seconds

boolean
address
required
One of:

Host name or IP address players connect to

string
port
required
One of:
integer
players
required
integer
maxPlayers
required
integer
tags
required
Array<string>
language
required
One of:

Language code such as en or de-DE

string
lastSeen
required

Last heartbeat (Unix time in milliseconds)

integer format: int64
peakPlayers
required

Highest player count reported over two consecutive heartbeats

integer
project
required
One of:
object
slug
required
string
title
required
string
studios
required
Array
object
slug
required
string
/^[a-z0-9][a-z0-9-]{1,30}[a-z0-9]$/
name
required
string
tagline
required
string
logo
required
One of:

Image path relative to the API (/v1/media/…). null without an image.

string
cover
required
One of:

Image path relative to the API (/v1/media/…). null without an image.

string
members
required

Number of members

integer
projects
required

Number of visible projects

integer
players
required

Players on online servers of all projects

integer
createdAt
required

Unix time in milliseconds

integer format: int64
role
required
string
Allowed values: owner admin member
hidden

Hidden by moderation (only in /v1/me/studios)

boolean
projects
required

Own projects and projects of their studios (up to 100)

Array<object>
object
slug
required
string
/^[a-z0-9][a-z0-9-]{1,30}[a-z0-9]$/
title
required
string
tagline
required
string
genre
required
string
Allowed values: roleplay racing shooter survival parkour sandbox minigames simulation other
tags
required
Array<string>
status
required

Development stage, in this order: concept, development, alpha, beta, released

string
Allowed values: concept development alpha beta released
languages
required

Languages of the game (ISO 639-1), up to 10

Array<string>
Allowed values: en de fr es it pt nl pl cs sk hu ro bg el tr ru uk sv da no fi ar he hi th vi id ja ko zh
cover
required
One of:

Image path relative to the API (/v1/media/…). null without an image.

string
owner
required
One of:
object
type
required
Allowed value: studio
slug
required
string
name
required
string
logo
One of:

Image path relative to the API (/v1/media/…). null without an image.

string
players
required

Players on linked servers that are online

integer
online
required

Linked servers that are online

integer
items
required

Linked marketplace items with at least one free version

integer
favorites
required

Accounts that marked the project as a favorite

integer
views
required

Page views (counted once per visitor and day, the team not included)

integer
createdAt
required

Unix time in milliseconds

integer format: int64
updatedAt
required

Unix time in milliseconds

integer format: int64
releasedAt
required
One of:

First time the status was set to released

integer format: int64
publishedAt
required
One of:

When the project was published. null: draft, only the team sees it

integer format: int64
achievements
required
object
unlocked
required
integer
total
required
integer
points
required
integer
maxPoints
required
integer
showcase
required

The 6 rarest unlocked achievements (without progress)

Array<object>
object
id
required
string
category
required
string
Allowed values: start creator operator studios projects veteran community secret play
tier
required
string
Allowed values: bronze silver gold platinum
points
required
integer
title
required

Hidden achievements show a placeholder until unlocked

string
description
required
string
icon
required

Icon name

string
source
required

platform: from real numbers. staff: granted by the team. game: comes with the launcher.

string
Allowed values: platform staff game
hidden
required

Still hidden for this viewer

boolean
percent
required

Share of all accounts that unlocked it, in percent

number
unlockedAt
required
One of:

Unix time in milliseconds

integer format: int64
progress
required
One of:
object
value
required
integer
goal
required
integer
connections
required

Steam and Discord accounts the person chose to show. Always empty for accounts under 16.

Array<object>
object
provider
required
string
Allowed values: steam discord
name
required
One of:
string
url
required

Profile page at the provider

string format: uri
country
required
One of:

Country the person says they are from (ISO 3166-1 alpha-2). Always null for accounts under 16.

string
/^[A-Z]{2}$/
links
required

Profiles on other platforms the person entered themselves (not verified). Always empty for accounts under 16.

Array<object>
object
platform
required
string
Allowed values: twitch kick youtube tiktok instagram x facebook reddit github bluesky
handle
required

Name on the platform. YouTube uses @name or channel/<id>, Facebook a username or a numeric profile ID.

string
url
required

Profile page, built by GAMPEON from the name. Never a link the person entered.

string format: uri

Example 

{
  "resources": [
    {
      "kind": "script"
    }
  ],
  "studios": [
    {
      "role": "owner"
    }
  ],
  "projects": [
    {
      "genre": "roleplay",
      "status": "concept",
      "languages": [
        "en"
      ],
      "owner": {
        "type": "studio"
      }
    }
  ],
  "achievements": {
    "showcase": [
      {
        "category": "start",
        "tier": "bronze",
        "source": "platform"
      }
    ]
  },
  "connections": [
    {
      "provider": "steam"
    }
  ],
  "links": [
    {
      "platform": "twitch"
    }
  ]
}

404

Section titled “404”

Error codes: not_found

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
  "error": "example",
  "message": "example"
}

Report a problem with this pageOther ways to give feedback