> ## Documentation Index
> Fetch the complete documentation index at: https://transcension.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Neighbors

> Provides information about adjacent positions or nodes on the game cube, useful for movement and tactical planning.



## OpenAPI

````yaml api-reference/cubic-api.json post /api/v1/cubic/neighbors
openapi: 3.0.0
info:
  title: Cubic Game API
  description: >-
    API documentation for the Cubic game, providing endpoints for game
    management, ship actions, and retrieving game state information.
  version: '1.0'
  contact:
    name: Cubic Game Support
servers:
  - url: http://50.187.81.221:4000
    description: Rendezvous Cubic Server.
  - url: https://cubic.ngrok.app
    description: Ender's Cubic Server.
security: []
tags:
  - name: Cubic
    description: Operations related to the Cubic game mechanics.
paths:
  /api/v1/cubic/neighbors:
    post:
      tags:
        - Cubic
      summary: Get Neighbors
      description: >-
        Provides information about adjacent positions or nodes on the game cube,
        useful for movement and tactical planning.
      operationId: CubicController_getNeighbors
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetNeighborsDTO'
            examples:
              getNeighborsExample:
                summary: Example of getting neighbors
                value:
                  gameID: uniqueGame123
        description: Request to get the neighboring cubes/vertices for a given game.
      responses:
        '201':
          description: List of neighbors retrieved successfully.
components:
  schemas:
    GetNeighborsDTO:
      type: object
      properties:
        gameID:
          type: string
          description: The unique identifier of the game.
      required:
        - gameID
      description: >-
        Data transfer object for requesting information about neighboring
        positions on the game cube.

````