Function listCountriesOfStargazers

List countries/regions of stargazers List countries/regions of stargazers for the specified repository.

Notice: In the overall data, about 3.5% of GitHub users provided valid country/region information.

Note: By default, the API does not count users without valid country/region information. If you need to count these users, you can set the exclude_unknown parameter to false.

  • listCountriesOfStargazers<ThrowOnError extends boolean = false>(
        options: Options<ListCountriesOfStargazersData, ThrowOnError>,
    ): RequestResult<
        {
            data: {
                columns: {
                    col: string;
                    data_type: | "CHAR"
                    | "BIGINT"
                    | "DECIMAL"
                    | "INT"
                    | "UNSIGNED BIGINT"
                    | "TINYINT"
                    | "TIMESTAMP"
                    | "TEXT"
                    | "VARCHAR"
                    | "DATETIME"
                    | "DOUBLE"
                    | "FLOAT"
                    | "DATE"
                    | "TIME"
                    | "YEAR"
                    | "MEDIUMINT"
                    | "SMALLINT"
                    | "BIT"
                    | "BINARY"
                    | "VARBINARY"
                    | "JSON"
                    | "ENUM"
                    | "SET"
                    | "TINYTEXT"
                    | "MEDIUMTEXT"
                    | "LONGTEXT"
                    | "TINYBLOB"
                    | "MEDIUMBLOB"
                    | "BLOB"
                    | "LONGBLOB";
                    nullable: boolean;
                    [key: string]: unknown;
                }[];
                result: {
                    code?: number;
                    databases?: string[];
                    end_ms?: number;
                    latency?: string;
                    limit?: number;
                    message?: string;
                    row_affect?: number;
                    row_count?: number;
                    start_ms?: number;
                    [key: string]: unknown;
                };
                rows: { country_code?: string; percentage?: string; stargazers?: string }[];
            };
            type: "sql_endpoint";
        },
        unknown,
        ThrowOnError,
    >

  • Type Parameters

    • ThrowOnError extends boolean = false

    Parameters

    Returns RequestResult<
        {
            data: {
                columns: {
                    col: string;
                    data_type: | "CHAR"
                    | "BIGINT"
                    | "DECIMAL"
                    | "INT"
                    | "UNSIGNED BIGINT"
                    | "TINYINT"
                    | "TIMESTAMP"
                    | "TEXT"
                    | "VARCHAR"
                    | "DATETIME"
                    | "DOUBLE"
                    | "FLOAT"
                    | "DATE"
                    | "TIME"
                    | "YEAR"
                    | "MEDIUMINT"
                    | "SMALLINT"
                    | "BIT"
                    | "BINARY"
                    | "VARBINARY"
                    | "JSON"
                    | "ENUM"
                    | "SET"
                    | "TINYTEXT"
                    | "MEDIUMTEXT"
                    | "LONGTEXT"
                    | "TINYBLOB"
                    | "MEDIUMBLOB"
                    | "BLOB"
                    | "LONGBLOB";
                    nullable: boolean;
                    [key: string]: unknown;
                }[];
                result: {
                    code?: number;
                    databases?: string[];
                    end_ms?: number;
                    latency?: string;
                    limit?: number;
                    message?: string;
                    row_affect?: number;
                    row_count?: number;
                    start_ms?: number;
                    [key: string]: unknown;
                };
                rows: { country_code?: string; percentage?: string; stargazers?: string }[];
            };
            type: "sql_endpoint";
        },
        unknown,
        ThrowOnError,
    >

Settings

Member Visibility