REST API for creating and querying competitive leaderboards across player populations. Supports global, friend-based, and partitioned leaderboards with configurable scoring, time windows, and reset schedules. Integrates with the LiveOps portal for managing leaderboard definitions and viewing rankings without code changes.
info:
title: realms basic
version: '1.0'
contact:
name: Beamable Support
url: https://api.beamable.com
email: [email protected]
servers:
- url: https://api.beamable.com
paths:
/basic/realms/customer/activate:
get:
responses:
'200':
description: ''
content:
text/html:
schema:
$ref: '#/components/schemas/HtmlResponse'
'400':
description: Bad Request
parameters:
- name: token
in: query
schema:
type: string
required: true
- name: cid
in: query
schema:
type: integer
format: int64
required: true
security:
- {}
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/project/beamable:
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProjectRequest'
security:
- user:
- developer
- server: []
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/customer/alias/available:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AliasAvailableResponse'
'400':
description: Bad Request
parameters:
- name: alias
in: query
schema:
type: string
required: true
security:
- {}
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/project:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectView'
'400':
description: Bad Request
security:
- {}
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProjectRequest'
security:
- user:
- developer
- server: []
put:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UnarchiveProjectRequest'
security:
- user:
- developer
- server: []
delete:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ArchiveProjectRequest'
security:
- user:
- developer
- server: []
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/customer/verify:
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NewCustomerResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NewCustomerRequest'
security:
- {}
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/games:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GetGameResponse'
'400':
description: Bad Request
security:
- user:
- tester
- server: []
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/config:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RealmConfigResponse'
'400':
description: Bad Request
security:
- user:
- tester
- server: []
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RealmConfigChangeRequest'
security:
- user:
- developer
- server: []
put:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RealmConfigSaveRequest'
security:
- user:
- developer
- server: []
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/project/rename:
put:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RenameProjectRequest'
security:
- user:
- developer
- server: []
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/plans:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ServicePlansResponse'
'400':
description: Bad Request
security:
- user:
- tester
- server: []
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePlanRequest'
security:
- user:
- developer
- server: []
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/client/defaults:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RealmConfiguration'
'400':
description: Bad Request
security:
- {}
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/customer:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerViewResponse'
'400':
description: Bad Request
security:
- user:
- tester
- server: []
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NewCustomerResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NewCustomerRequest'
security:
- {}
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/admin/inflight/failures:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/InFlightFailureResponse'
'400':
description: Bad Request
parameters:
- name: serviceObjectId
in: query
schema:
type: string
required: false
- name: serviceName
in: query
schema:
type: string
required: true
security:
- user:
- developer
- server: []
delete:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDeleteInFlightRequest'
security:
- user:
- developer
- server: []
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/launch-message:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/LaunchMessageListResponse'
'400':
description: Bad Request
security:
- user:
- tester
- server: []
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLaunchMessageRequest'
security:
- user:
- developer
- server: []
delete:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveLaunchMessageRequest'
security:
- user:
- developer
- server: []
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/is-customer:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EmptyResponse'
'400':
description: Bad Request
security:
- {}
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/admin/customer:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerResponse'
'400':
description: Bad Request
security:
- user:
- developer
- server: []
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/game:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GetGameResponse'
'400':
description: Bad Request
parameters:
- name: rootPID
in: query
schema:
type: string
x-beamable-semantic-type: Pid
required: true
security:
- user:
- tester
- server: []
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NewGameRequest'
security:
- user:
- developer
- server: []
put:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateGameHierarchyRequest'
security:
- user:
- developer
- server: []
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/project/promote:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PromoteRealmResponseOld'
'400':
description: Bad Request
parameters:
- name: sourcePid
in: query
schema:
type: string
x-beamable-semantic-type: Pid
required: true
- name: promotions
in: query
schema:
type: array
items:
type: string
format: blah
required: false
- name: contentManifestIds
in: query
schema:
type: array
items:
type: string
format: blah
required: false
security:
- user:
- tester
- server: []
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PromoteRealmResponseOld'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PromoteRealmRequest'
security:
- user:
- developer
- server: []
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/customers:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersResponse'
'400':
description: Bad Request
security:
- {}
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
/basic/realms/promotion:
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PromoteRealmResponse'
'400':
description: Bad Request
parameters:
- name: sourcePid
in: query
schema:
type: string
x-beamable-semantic-type: Pid
required: true
- name: promotions
in: query
schema:
type: array
items:
type: string
format: blah
required: false
- name: contentManifestIds
in: query
schema:
type: array
items:
type: string
format: blah
required: false
security:
- user:
- tester
- server: []
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PromoteRealmResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PromoteRealmRequest'
security:
- user:
- developer
- server: []
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred
by the auth token.
required: false
components:
schemas:
Promotable:
type: object
additionalProperties: false
properties:
checksum:
type: string
createdAt:
type: integer
format: int64
required:
- checksum
- createdAt
ArchiveProjectRequest:
properties:
pid:
type: string
x-beamable-semantic-type: Pid
additionalProperties: false
title: Archive Project Request
type: object
required:
- pid
InFlightMessage:
type: object
additionalProperties: false
properties:
method:
type: string
body:
type: string
path:
type: string
gamerTag:
type: integer
format: int64
limitFailureRetries:
type: boolean
shard:
type: string
service:
type: string
id:
type: string
required:
- service
- id
- method
- path
- body
UpdateGameHierarchyRequest:
properties:
rootPID:
type: string
x-beamable-semantic-type: Pid
projects:
type: array
items:
$ref: '#/components/schemas/ProjectView'
additionalProperties: false
title: Update Game Hierarchy Request
type: object
required:
- rootPID
- projects
LaunchMessageListResponse:
properties:
files:
type: array
items:
type: string
additionalProperties: false
title: Launch Message List Response
type: object
required:
- files
CustomerResponse:
properties:
customer:
$ref: '#/components/schemas/Customer'
additionalProperties: false
title: Customer Response
type: object
required:
- customer
CustomersResponse:
properties:
result:
type: array
items:
$ref: '#/components/schemas/Customer'
additionalProperties: false
title: Customers Response
type: object
required:
- result
CreatePlanRequest:
properties:
name:
type: string
messageBusAnalytics:
type: array
items:
type: string
mongoSrvAddress:
type: string
memcachedHosts:
type: string
mongoSSL:
type: boolean
platformJBDC:
type: string
sharded:
type: boolean
mongoHosts:
type: string
messageBusCommon:
type: array
items:
type: string
redisShards:
type: array
items:
$ref: '#/components/schemas/RedisShardRequest'
additionalProperties: false
title: Create Plan Request
type: object
required:
- name
- mongoHosts
- sharded
- mongoSSL
- platformJBDC
- memcachedHosts
- redisShards
ContentLimits:
type: object
additionalProperties: false
properties:
maxDistinctContentIds:
type: integer
format: int32
ServiceLimits:
type: object
additionalProperties: false
properties:
beamo:
$ref: '#/components/schemas/BeamoLimits'
content:
$ref: '#/components/schemas/ContentLimits'
gateway:
$ref: '#/components/schemas/GatewayLimits'
CommonResponse:
properties:
result:
type: string
data:
type: object
additionalProperties:
type: string
additionalProperties: false
title: Common Response
type: object
required:
- result
- data
FailedInFlightFilterRequest:
properties:
serviceObjectId:
type: string
serviceName:
type: string
additionalProperties: false
title: Failed In Flight Filter Request
type: object
required:
- serviceName
GatewayLimits:
type: object
additionalProperties: false
properties:
maxConcurrentRequests:
type: integer
format: int32
required:
- maxConcurrentRequests
RealmConfigChangeRequest:
properties:
upserts:
type: object
additionalProperties:
type: string
deletes:
type: array
items:
type: string
additionalProperties: false
title: Realm Config Change Request
type: object
RealmConfiguration:
properties:
websocketConfig:
$ref: '#/components/schemas/WebSocketConfiguration'
microserviceURI:
type: string
portalURI:
type: string
microserviceEcrURI:
type: string
storageBrowserURI:
type: string
environment:
type: string
additionalProperties: false
title: Realm Configuration
type: object
required:
- environment
- websocketConfig
- microserviceURI
- microserviceEcrURI
- portalURI
- storageBrowserURI
NewCustomerRequest:
properties:
projectName:
type: string
email:
type: string
customerName:
type: string
hierarchy:
type: boolean
alias:
type: string
password:
type: string
additionalProperties: false
title: New Customer Request
type: object
required:
- projectName
- email
- password
PromoteRealmResponseOld:
properties:
sourcePid:
type: string
promotions:
type: array
items:
$ref: '#/components/schemas/RealmPromotion'
additionalProperties: false
title: Promote Realm Response Old
type: object
required:
- sourcePid
- promotions
CustomerView:
type: object
additionalProperties: false
properties:
cid:
type: integer
format: int64
x-beamable-semantic-type: Cid
name:
type: string
alias:
type: string
projects:
type: array
items:
$ref: '#/components/schemas/ProjectView'
required:
- cid
- name
- projects
GetGameResponse:
properties:
projects:
type: array
items:
$ref: '#/components/schemas/ProjectView'
additionalProperties: false
title: Get Game Response
type: object
required:
- projects
PromoteRealmRequest:
properties:
sourcePid:
type: string
x-beamable-semantic-type: Pid
promotions:
type: array
items:
type: string
contentManifestIds:
type: array
items:
type: string
additionalProperties: false
title: Promote Realm Request
type: object
required:
- sourcePid
CreateLaunchMessageRequest:
properties:
name:
type: string
body:
type: string
additionalProperties: false
title: Create Launch Message Request
type: object
required:
- name
- body
RealmConfigSaveRequest:
properties:
config:
type: object
additionalProperties:
type: string
additionalProperties: false
title: Realm Config Save Request
type: object
required:
- config
InFlightFailureResponse:
properties:
failures:
type: array
items:
$ref: '#/components/schemas/InFlightFailure'
additionalProperties: false
title: In Flight Failure Response
type: object
required:
- failures
PromotionScope:
type: object
additionalProperties: false
properties:
name:
type: string
promotions:
type: array
items:
$ref: '#/components/schemas/Promotion'
required:
- name
- promotions
HtmlResponse:
properties:
html:
type: string
additionalProperties: false
title: Html Response
type: object
required:
- html
ServicePlan:
type: object
additionalProperties: false
properties:
minCustomerStatusSaved:
type: string
name:
type: string
dataDomain:
$ref: '#/components/schemas/DataDomain'
limits:
$ref: '#/components/schemas/ServiceLimits'
created:
type: integer
format: int64
required:
- name
- dataDomain
CustomerViewResponse:
properties:
customer:
$ref: '#/components/schemas/CustomerView'
additionalProperties: false
title: Customer View Response
type: object
required:
- customer
AliasAvailableResponse:
properties:
alias:
type: string
available:
type: boolean
cid:
type: i
# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/beamable/refs/heads/main/openapi/beamable-leaderboards-openapi.yml