Skip to main content
Version: v1beta

OSSInsight Public API

OSSInsight Public APIs (beta) provide a convenient way to access insight data for open source projects on GitHub, supplementing the existing GitHub API.

It provides data query in different dimensions, including:

Usage​

The OSSInsight Public API is designed to follow the OpenAPI specification and can be accessed by initiating HTTP requests using the command line curl or web request libraries in different programming languages.

Base URL​

All API requests are based on the following URL:

https://api.ossinsight.io/v1

Authentication​

No authentication is required for beta version of public APIs, but there are rate limits for API requests.

Note: We will add authentication way for larger API requests in future releases.

Rate Limit​

For each IP address, the rate limit allows for up to 600 requests per hour, which can be checked by the following fields in the Response Header to see the current usage:

x-ratelimit-limit: 600
x-ratelimit-remaining: 599

In addition, we have also set up a global rate limit of up to 1000 requests per minute, which can be checked by the following fields in the Response Header to see the current usage:

x-ratelimit-limit-minute: 1000
x-ratelimit-remaining-minute: 97

Example​

For example, if you want to know what countries the stargazers in the pingcap/tidb repository are located in, you can make a request using the curl command as follows:

curl https://api.ossinsight.io/v1/repos/pingcap/tidb/stargazers/countries
Example Response
{
  "type": "sql_endpoint",
  "data": {
    "columns": [
      {
        "col": "country_or_area",
        "data_type": "CHAR",
        "nullable": true
      },
      {
        "col": "count",
        "data_type": "BIGINT",
        "nullable": true
      },
      {
        "col": "percentage",
        "data_type": "DECIMAL",
        "nullable": true
      }
    ],
    "rows": [
      {
        "count": "9183",
        "country_or_area": "CN",
        "percentage": "0.5936"
      },
      {
        "count": "1542",
        "country_or_area": "US",
        "percentage": "0.0997"
      },
      {
        "count": "471",
        "country_or_area": "JP",
        "percentage": "0.0304"
      }
    ],
    "result": {
      "code": 200,
      "message": "Query OK!",
      "start_ms": 1690351487809,
      "end_ms": 1690351487930,
      "latency": "121ms",
      "row_count": 132,
      "row_affect": 0,
      "limit": 300,
      "databases": [
        "gharchive_dev"
      ]
    }
  }
}

Request New API​

If the API in the documentation does not meet your query requirements, please contact us as follows: