@kayahr/edsm
    Preparing search index...

    Interface SystemResponse

    Response of a getSystem request.

    interface SystemResponse {
        coords?: { x: number; y: number; z: number };
        coordsLocked?: boolean;
        duplicates?: number[];
        hidden_at?: string;
        id?: number;
        id64?: Id64;
        information?: {
            allegiance?: string;
            economy?: string;
            faction?: string;
            factionState?: string;
            government?: string;
            population?: number;
            reserve?: string;
            secondEconomy?: string;
            security?: string;
        };
        mergedTo?: number;
        name: string;
        permitName?: string;
        primaryStar?: { isScoopable: boolean; name: string; type: string };
        requirePermit?: boolean;
    }
    Index

    Properties

    coords? coordsLocked? duplicates? hidden_at? id? id64? information? mergedTo? name permitName? primaryStar? requirePermit?

    Properties

    coords?: { x: number; y: number; z: number }

    The coordinates of the system. Only present when SystemRequestOptions#showCoordinates option is set to 1.

    coordsLocked?: boolean

    True when exact coords are known. False when position is trilaterated. Only present when SystemRequestOptions#showCoordinates option is set to 1

    duplicates?: number[]

    The systems ID having the exact same name in the game. Only present when there are duplicated and SystemRequestOptions#showId option is set to 1.

    hidden_at?: string

    The time when the system was hidden. Only present when system is hidden and SystemRequestOptions#includeHidden is set to 1

    id?: number

    The EDSM ID of the system. Only present when SystemRequestOptions#showId option is set to 1.

    id64?: Id64

    The Frontier ID of the system. Only present when SystemRequestOptions#showId option is set to 1.

    information?: {
        allegiance?: string;
        economy?: string;
        faction?: string;
        factionState?: string;
        government?: string;
        population?: number;
        reserve?: string;
        secondEconomy?: string;
        security?: string;
    }

    System information. Only present when SystemRequestOptions#showInformation option is set to 1.

    mergedTo?: number

    The system ID this system was merged to. Only present when system was merged and, SystemRequestOptions#includeHidden is set to 1 and SystemRequestOptions#showId is also set to 1.

    name: string

    The name of the system.

    permitName?: string

    Permit name if any. Only present when SystemRequestOptions#showPermit option is set to 1.

    primaryStar?: { isScoopable: boolean; name: string; type: string }

    Information about the primary star if any. Only present when SystemRequestOptions#showPrimaryStar option is set to 1.

    requirePermit?: boolean

    Permit information. Only present when SystemRequestOptions#showPermit option is set to 1.

    Settings

    Member Visibility

    On This Page

    Properties