Unity

Unity Search API

Discover and join lobbies

Documentation GitHub OpenAPI

Operations 1

POST /v1/lobbies/query Query Lobbies #

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/unity-search-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Unity Lobby Search API
  description: The Unity Lobby REST API provides endpoints for creating, managing, and querying multiplayer game lobbies. Lobbies allow players to group together before starting a game session. Supports public lobbies with search/filter, private lobbies with join codes, lobby data for game configuration, and player data for per-player attributes.
  version: v1.0.0
  termsOfService: https://unity.com/legal/terms-of-service
  contact:
    name: Unity Support
    url: https://support.unity.com
  license:
    name: Unity Terms of Service
    url: https://unity.com/legal/terms-of-service
servers:
- url: https://lobby.services.api.unity.com
  description: Unity Lobby Production Server
security:
- bearerAuth: []
tags:
- name: Search
  description: Discover and join lobbies
paths:
  /v1/lobbies/query:
    post:
      operationId: queryLobbies
      summary: Query Lobbies
      description: Searches for available lobbies using filter and sort criteria. Only returns public lobbies.
      tags:
      - Search
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryLobbiesRequest'
      responses:
        '200':
          description: List of matching lobbies
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LobbyList'
components:
  schemas:
    QueryFilter:
      type: object
      required:
      - field
      - value
      - op
      properties:
        field:
          type: string
          enum:
          - AvailableSlots
          - MaxPlayers
          - Created
          - LastUpdated
          - S1
          - S2
          - S3
          - S4
          - S5
          - N1
          - N2
          - N3
          - N4
          - N5
        value:
          type: string
        op:
          type: string
          enum:
          - EQ
          - NE
          - LT
          - LE
          - GT
          - GE
          - CONTAINS
          - NOT_CONTAINS
    DataObject:
      type: object
      properties:
        value:
          type: string
        visibility:
          type: string
          enum:
          - Public
          - Member
          - Private
        index:
          type: string
    Lobby:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        lobbyCode:
          type: string
          description: Join code for private lobbies
        isPrivate:
          type: boolean
        isLocked:
          type: boolean
        maxPlayers:
          type: integer
        availableSlots:
          type: integer
        hostId:
          type: string
        data:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DataObject'
        players:
          type: array
          items:
            $ref: '#/components/schemas/LobbyPlayer'
        created:
          type: string
          format: date-time
        lastUpdated:
          type: string
          format: date-time
    QueryLobbiesRequest:
      type: object
      properties:
        count:
          type: integer
          default: 10
        continuationToken:
          type: string
        filter:
          type: array
          items:
            $ref: '#/components/schemas/QueryFilter'
        order:
          type: array
          items:
            $ref: '#/components/schemas/QueryOrder'
    LobbyList:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/Lobby'
        continuationToken:
          type: string
    QueryOrder:
      type: object
      properties:
        field:
          type: string
        asc:
          type: boolean
    LobbyPlayer:
      type: object
      properties:
        id:
          type: string
        data:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DataObject'
        joined:
          type: string
          format: date-time
        lastUpdated:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Unity Lobby Documentation
  url: https://docs.unity.com/ugs/en-us/manual/lobby/manual/lobby-apis