Development

Development data provides information about activities in the protocol's git repository

Retrieves the development data for repositories of the specified protocol

get

This endpoint returns the development related data for protocol's tracked GitHub repositories from the last 7 days.

Authorizations

Path parameters

protocolstringRequired

The name of the protocol in lowercase.

Example: compound

Responses

200

OK

application/json

404

There is no data for the provided `protocol`

505

Internal Server Error

get

HTTPcURLJavaScriptPython

GET /data/development/{protocol} HTTP/1.1
Host: api.alterscope.org
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "activity_events": 4,
    "branches": 3,
    "collaborators": -1,
    "commit_comments": 0,
    "top_contributor_weight": 93.33333333333333,
    "contributors": 70,
    "contributions_mean": 21,
    "contributions_absolute_deviation": 30.8,
    "gini_coefficient": 0.7504761904761905,
    "num_issues": 3,
    "num_issues_events": 238,
    "num_pulls": 3,
    "repos": 75,
    "num_commit_t": 105,
    "num_commit_w": 0,
    "num_commit_m": 0,
    "url": "https://github.com/compound-finance/compound-finance.github.io",
    "timestamp": "2024-01-06T00:10:27.918373285Z",
    "forks": 9,
    "watchers": 10,
    "stars": 6
  },
  {
    "activity_events": 0,
    "branches": 5,
    "collaborators": -1,
    "commit_comments": 0,
    "top_contributor_weight": 61.66666666666667,
    "contributors": 70,
    "contributions_mean": 10,
    "contributions_absolute_deviation": 9,
    "gini_coefficient": 0.5333333333333333,
    "num_issues": 5,
    "num_issues_events": 202,
    "num_pulls": 5,
    "repos": 75,
    "num_commit_t": 60,
    "num_commit_w": 0,
    "num_commit_m": 0,
    "url": "https://github.com/compound-finance/comet-extension",
    "timestamp": "2024-01-06T00:10:25.568272377Z",
    "forks": 4,
    "watchers": 9,
    "stars": 9
  }
]

Sample Request

Note: The sample request below shows development data for repositories of compound protocol.

curl https://api.alterscope.org/data/development/compound -H "Authorization: Bearer <your_access_token>"

Note: For a comprehensive list of protocols whose data can be requested please refer to supported protocols page. Note: For getting Frax Finance and Radiant Capital protocol development data pass them as fraxfinance and radiantcapital(nospaces in lowercase).

Sample Response

Note: The sample response below is shortened for formatting purposes and only show data for a single repository of the specified protocol. The actual response will show data for all repositories for a specified protocol.

{
   "status":true,
   "data":[
      {
         "activity_events":0,
         "branches":3,
         "collaborators":-1,
         "commit_comments":0,
         "top_contributor_weight":93.33333333333333,
         "contributors":5,
         "contributions_mean":21,
         "contributions_absolute_deviation":30.8,
         "gini_coefficient":0.7504761904761905,
         "num_issues":3,
         "num_issues_events":238,
         "num_pulls":3,
         "repos":75,
         "num_commit_t":105,
         "num_commit_w":0,
         "num_commit_m":0,
         "url":"https://github.com/compound-finance/compound-finance.github.io",
         "timestamp":"2024-02-15T00:10:51.295897238Z",
         "forks":9,
         "watchers":10,
         "stars":6
      }

Sample Response Description

activity_events: This represents the number of events or activities related to repositories of a particular protocol. It could include actions like code pushes, pull requests, issues created or closed, and other significant interactions within a given timeframe.

branches: Indicates the number of distinct branches in a version control system, such as Git.

collaborators: The count of collaborators involved with repositories of a particular protocol.

commit_comments: Represents the number of comments made on commits in a version control system.

top_contributor_weight: Indicates the significance of top contributor in the project.

contributions_mean: Represents the average value of contributions made, providing a measure of individual contributions within the project.

contributions_absolute_deviation: Indicates the absolute deviation of contributions from the mean. It measures the spread of individual contributions around the average value.

gini_coefficient: A statistical measure of inequality, often used to assess the distribution of contributions. A higher Gini coefficient suggests a more unequal distribution.

num_issues: Represents the total number of issues reported in the project.

num_issues_events: Signifies the total number of events related to issues, encompassing actions like opening, closing, or commenting on issues.

num_pulls: Indicates the total number of pull requests, which represent proposed changes to the codebase.

repos: Represents the number of repositories associated with a particular project.

num_commit_t : Signifies the total number of commits, which are individual changes to the codebase.

num_commit_w: Indicates the number of commits on weekdays.

num_commit_m : Represents the number of commits in a month.

url: Specifies the web address (URL) of the GitHub repository.

timestamp: Represents the date and time when the information was collected.

forks: Indicates the number of times the repository has been forked by other GitHub users.

watchers: Represents the number of users who have chosen to receive notifications about updates and changes to the repository.

stars: Signifies the number of users who have marked the repository with a star, indicating their interest.

---

Retrieves the aggregated development data gathered from the tracked repositories of the specified protocol.

get

This endpoint returns the aggregated development data for protocol from across its tracked GitHub repositories from the last 7 days.

Authorizations

Path parameters

protocolstringRequired

The name of the Protocol in lowercase

Example: compound

Responses

200

OK

application/json

404

There is no data for the provided `protocol`

505

Internal Server Error

get

HTTPcURLJavaScriptPython

GET /data/development/{protocol}/stats HTTP/1.1
Host: api.alterscope.org
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "activity_events": 622,
    "branches": 322,
    "collaborators": -1,
    "commit_comments": 24,
    "top_contributor_weight": 56.69967813905448,
    "contributors": 85,
    "contributions_mean": 19.723456790123457,
    "contributions_absolute_deviation": 15.703895747599452,
    "gini_coefficient": 0.5026672617268086,
    "num_issues": 136,
    "num_issues_events": 9532,
    "num_pulls": 74,
    "repos": 75,
    "num_commit_t": 1060,
    "num_commit_w": 0,
    "num_commit_m": 0,
    "url": "https://github.com/compound-finance",
    "timestamp": "2024-01-07T00:10:28.01852021Z",
    "forks": 1771,
    "watchers": 190,
    "stars": 2509
  },
  {
    "activity_events": 626,
    "branches": 322,
    "collaborators": -1,
    "commit_comments": 24,
    "top_contributor_weight": 56.69967813905448,
    "contributors": 85,
    "contributions_mean": 19.723456790123457,
    "contributions_absolute_deviation": 15.703895747599452,
    "gini_coefficient": 0.5026672617268086,
    "num_issues": 136,
    "num_issues_events": 9532,
    "num_pulls": 74,
    "repos": 75,
    "num_commit_t": 1060,
    "num_commit_w": 0,
    "num_commit_m": 0,
    "url": "https://github.com/compound-finance",
    "timestamp": "2024-01-06T00:10:28.94241005Z",
    "forks": 1771,
    "watchers": 190,
    "stars": 2509
  }
]

Sample Request

Note: The sample request below shows development data gathered from tracked repositories of compound protocol.

curl https://api.alterscope.org/data/development/compound/stats -H "Authorization: Bearer <your_access_token>"

Note: For a comprehensive list of protocols whose data can be requested please refer to supported protocols page. Note: For getting Frax Finance and Radiant Capital protocol data stats pass them as fraxfinance and radiantcapital(nospaces in lowercase).

Sample Response

The sample response below is shortened for formatting purposes. The actual response will display data for past 7 days.

{
   "status":true,
   "data":[
      {
         "activity_events":681,
         "branches":322,
         "collaborators":-1,
         "commit_comments":24,
         "top_contributor_weight":56.69967813905448,
         "contributors":36,
         "contributions_mean":19.723456790123457,
         "contributions_absolute_deviation":15.703895747599452,
         "gini_coefficient":0.5026672617268086,
         "num_issues":140,
         "num_issues_events":9550,
         "num_pulls":75,
         "repos":75,
         "num_commit_t":1060,
         "num_commit_w":0,
         "num_commit_m":0,
         "url":"https://github.com/compound-finance",
         "timestamp":"2024-02-15T00:10:52.334521259Z",
         "forks":1796,
         "watchers":191,
         "stars":2534
      },
      {
         "activity_events":656,
         "branches":322,
         "collaborators":-1,
         "commit_comments":24,
         "top_contributor_weight":56.69967813905448,
         "contributors":36,
         "contributions_mean":19.723456790123457,
         "contributions_absolute_deviation":15.703895747599452,
         "gini_coefficient":0.5026672617268086,
         "num_issues":139,
         "num_issues_events":9545,
         "num_pulls":74,
         "repos":75,
         "num_commit_t":1060,
         "num_commit_w":0,
         "num_commit_m":0,
         "url":"https://github.com/compound-finance",
         "timestamp":"2024-02-14T00:10:24.324152629Z",
         "forks":1797,
         "watchers":191,
         "stars":2532
      }

Sample Response Description

activity_events: This represents the number of events or activities related to repositories of a particular protocol. It could include actions like code pushes, pull requests, issues created or closed, and other significant interactions within a given timeframe.

branches: Indicates the number of distinct branches in a version control system, such as Git.

collaborators: The count of collaborators involved in a project.

commit_comments: Represents number of comments made on commits in a version control system.

top_contributor_weight: Indicates the significance of the top contributor in the project. This could be a weighted measure, reflecting the impact of the leading contributor in terms of code contributions.

contributions_mean: Represents the average value of contributions made, providing a measure of the typical size or scope of individual contributions within the project.

contributions_absolute_deviation: Indicates the absolute deviation of contributions from the mean.

gini_coefficient: A statistical measure of inequality, often used to assess the distribution of contributions among contributors. A higher Gini coefficient suggests a more unequal distribution.

num_issues: Represents the total number of issues reported in the project.

num_issues_events: Signifies the total number of events related to issues, encompassing actions like opening, closing, or commenting on issues.

num_pulls: Indicates the total number of pull requests, which represent proposed changes to the codebase.

repos: Represents the number of repositories associated with a particular protocol.

num_commit_t: Signifies the total number of commits, which are individual changes to the codebase.

num_commit_w: Indicates the number of commits on weekdays.

num_commit_m: Indicates the number of commits in a month.

url: Specifies the web address (URL) of the GitHub repository.

timestamp: Represents the date and time when the information were collected.

forks: Indicates the number of times the repository has been forked by other GitHub users.

watchers: Represents the number of users who have chosen to receive notifications about updates to the repository.

stars: Signifies the number of users who have marked the repository with a star.

---