@kayahr/edsm
    Preparing search index...

    Interface CubeSystemsRequestOptions

    Options for getCubeSystems request.

    interface CubeSystemsRequestOptions {
        includeHidden?: number;
        showCoordinates?: number;
        showId?: number;
        showInformation?: number;
        showPermit?: number;
        showPrimaryStar?: number;
        size?: number;
        systemId?: number;
        systemId64?: Id64;
    }

    Hierarchy (View Summary)

    Index

    Properties

    includeHidden? showCoordinates? showId? showInformation? showPermit? showPrimaryStar? size? systemId? systemId64?

    Properties

    includeHidden?: number

    Set to 1 to get system even if hidden in the database. Hidden system are generally typo errors, renamed system in the game...

    showCoordinates?: number

    Set to 1 to get the system coordinates. If coordinates are unknown, the coords key will not be returned.

    showId?: number

    Set to 1 to get our internal ID for this system.

    showInformation?: number

    Set to 1 to get the system information like allegiance, government... If no information are stored, an empty object will be returned.

    showPermit?: number

    Set to 1 to get the system permit if there is one. If the permit is named, also return permitName.

    showPrimaryStar?: number

    Set to 1 to get the system primary star if known. If no primary star is stored, null will be returned.

    size?: number

    Desired cube size in LY. Defaults to 100, maximum is 200.

    systemId?: number

    The system ID if you seek for a duplicate system and want to force a specific ID.

    systemId64?: Id64

    The system ID64 if you seek for a duplicate system and want to force a specific ID.

    Settings

    Member Visibility

    On This Page

    Properties