Development

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

Retrieves the development data for repositories of the specified protocol

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

GEThttps://api.alterscope.org/data/development/{protocol}

Authorization

Path parameters

protocol*string

The name of the protocol in lowercase.

Example: "compound"

Response

Body

activity_eventsstring

branchesnumber

collaboratorsstring

commit_commentsnumber

top_contributor_weightnumber

contributorsnumber

contributions_meannumber

contributions_absolute_deviationnumber

gini_coefficientnumber

num_issuesnumber

num_issues_eventsnumber

num_pullsnumber

reposnumber

num_commit_tnumber

num_commit_wnumber

num_commit_mnumber

urlstring

timestampstring

forksnumber

watchersnumber

starsnumber

Request

const response = await fetch('https://api.alterscope.org/data/development/{protocol}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

[
  {
    "activity_events": "text",
    "branches": 0,
    "collaborators": "text",
    "commit_comments": 0,
    "top_contributor_weight": 0,
    "contributors": 0,
    "contributions_mean": 0,
    "contributions_absolute_deviation": 0,
    "gini_coefficient": 0,
    "num_issues": 0,
    "num_issues_events": 0,
    "num_pulls": 0,
    "repos": 0,
    "num_commit_t": 0,
    "num_commit_w": 0,
    "num_commit_m": 0,
    "url": "text",
    "timestamp": "text",
    "forks": 0,
    "watchers": 0,
    "stars": 0
  }
]

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

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
      }

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.

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

GEThttps://api.alterscope.org/data/development/{protocol}/stats

Authorization

Path parameters

protocol*string

The name of the Protocol in lowercase

Example: "compound"

Response

Body

activity_eventsstring

branchesnumber

collaboratorsstring

commit_commentsnumber

top_contributor_weightnumber

contributorsnumber

contributions_meannumber

contributions_absolute_deviationnumber

gini_coefficientnumber

num_issuesnumber

num_issues_eventsnumber

num_pullsnumber

reposnumber

num_commit_tnumber

num_commit_wnumber

num_commit_mnumber

urlstring

timestampstring

forksnumber

watchersnumber

starsnumber

Request

const response = await fetch('https://api.alterscope.org/data/development/{protocol}/stats', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

[
  {
    "activity_events": "text",
    "branches": 0,
    "collaborators": "text",
    "commit_comments": 0,
    "top_contributor_weight": 0,
    "contributors": 0,
    "contributions_mean": 0,
    "contributions_absolute_deviation": 0,
    "gini_coefficient": 0,
    "num_issues": 0,
    "num_issues_events": 0,
    "num_pulls": 0,
    "repos": 0,
    "num_commit_t": 0,
    "num_commit_w": 0,
    "num_commit_m": 0,
    "url": "text",
    "timestamp": "text",
    "forks": 0,
    "watchers": 0,
    "stars": 0
  }
]

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

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
      }

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.

Last updated 6 months ago