@kayahr/edsm
    Preparing search index...

    Interface SphereSystemsRequestOptions

    Options for getSphereSystems request.

    interface SphereSystemsRequestOptions {
        includeHidden?: number;
        minRadius?: number;
        radius?: number;
        showCoordinates?: number;
        showId?: number;
        showInformation?: number;
        showPermit?: number;
        showPrimaryStar?: number;
        systemId?: number;
        systemId64?: Id64;
    }

    Hierarchy (View Summary)

    Index

    Properties

    includeHidden? minRadius? radius? showCoordinates? showId? showInformation? showPermit? showPrimaryStar? 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...

    minRadius?: number

    The minimum radius in LY. Must be between 0 and radius. Defaults to 0.

    radius?: number

    Desired radius in LY. Defaults to 50, maximum is 100.

    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.

    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