@kayahr/edsm
    Preparing search index...

    Interface SystemsRequestOptions

    Options for getSystems request.

    interface SystemsRequestOptions {
        endDateTime?: string;
        includeHidden?: number;
        onlyKnownCoordinates?: number;
        onlyUnknownCoordinates?: number;
        showCoordinates?: number;
        showId?: number;
        showInformation?: number;
        showPermit?: number;
        showPrimaryStar?: number;
        startDateTime?: string;
        systemName?: string | string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    endDateTime? includeHidden? onlyKnownCoordinates? onlyUnknownCoordinates? showCoordinates? showId? showInformation? showPermit? showPrimaryStar? startDateTime? systemName?

    Properties

    endDateTime?: string

    If you only want to receive systems updated before a specific date & time, use this parameter. Parameter is inclusive. All dates must be UTC. Format: YYYY-MM-DD HH:MM:SS.

    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...

    onlyKnownCoordinates?: number

    Set to 1 to get only systems with known coordinates.

    onlyUnknownCoordinates?: number

    Set to 1 to get only systems without coordinates.

    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.

    startDateTime?: string

    If you only want to receive systems updated after a specific date & time, use this parameter. Parameter is inclusive. All dates must be UTC. Format: YYYY-MM-DD HH:MM:SS.

    systemName?: string | string[]

    The systems name to retrieve, can be a start of a name or an array of specific names.

    Settings

    Member Visibility

    On This Page

    Properties