Velocity

Try in Playground

Retrieve authored, merged and open PR totals for a creation-date window, with selectable summary, repository or full enrichment.

GET/v1/github/user/profile-velocityx-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

handlestringrequiredquery

GitHub handle, optionally beginning with @; 1–39 characters excluding @.

Exampleexample

depthenumquery

quick, default or deep; controls repository enrichment width.

one of: quick, default, deep

Examplequick

sincestringquery

Inclusive PR creation start date, YYYY-MM-DD.

untilstringquery

Inclusive PR creation end date, YYYY-MM-DD.

sectionsenumquery

Velocity detail: summary, repositories or full.

one of: summary, repositories, full

Examplesummary

Response fields

203

platformstringoptional

Optional.

endpointstringoptional

Optional.

successboolean

Whether retrieval returned usable data.

statusenum

success, partial, failed or challenged.

one of: success, partial

requestIdstring

Request correlation UUID.

sourceUrlstring

Public source URL.

absolute HTTPS URL

fetchedAtstring

UTC fetch time.

Completeness of this bounded response, not complete account enumeration.

coverage.sourceenum

Always included.

one of: public_api, public_html

coverage.completeboolean

Always included.

coverage.warningsstring[]

Always included.

Combined upstream attempts, decoded bytes and elapsed milliseconds.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

Route-specific compatibility payload. See endpoint description and research coverage notes.

Always included.

data.velocity.totalinteger

Always included.

≥ 0

data.velocity.mergedintegernullable

Always included.

data.velocity.openintegernullableoptional

Optional.

data.period.sincestringnullable

Always included.

data.period.untilstringnullable

Always included.

data.period.basisstring

Always included.

Optional.

data.sampling.sectionsenum

Always included.

one of: summary, repositories, full

data.sampling.authoredPullRequestsinteger

Always included.

≥ 0

data.sampling.externalRepositoryLimitinteger

Always included.

≥ 0

data.sampling.ownedRepositoryLimitinteger

Always included.

≥ 0

Always included.

up to 15 items

Always included.

data.contributed_repos.info.idinteger

Always included.

≥ 0

data.contributed_repos.info.node_idstring

Always included.

data.contributed_repos.info.namestring

Always included.

data.contributed_repos.info.full_namestring

Always included.

data.contributed_repos.info.owner.idinteger

Always included.

≥ 0

data.contributed_repos.info.owner.loginstring

Always included.

data.contributed_repos.info.owner.avatar_urlstring

Always included.

absolute HTTPS URL

data.contributed_repos.info.owner.urlstring

Always included.

absolute HTTPS URL

data.contributed_repos.info.owner.typestring

Always included.

data.contributed_repos.info.privateboolean

Always included.

data.contributed_repos.info.descriptionstringnullable

Always included.

data.contributed_repos.info.forkboolean

Always included.

data.contributed_repos.info.homepagestringnullable

Always included.

data.contributed_repos.info.languagestringnullable

Always included.

data.contributed_repos.info.forks_countinteger

Always included.

≥ 0

data.contributed_repos.info.watchers_countinteger

Always included.

≥ 0

data.contributed_repos.info.sizeinteger

Always included.

≥ 0

data.contributed_repos.info.default_branchstring

Always included.

data.contributed_repos.info.open_issues_countinteger

Always included.

≥ 0

data.contributed_repos.info.topicsstring[]

Always included.

data.contributed_repos.info.license.keystring

Always included.

data.contributed_repos.info.license.namestring

Always included.

data.contributed_repos.info.license.spdx_idstringnullable

Always included.

data.contributed_repos.info.archivedboolean

Always included.

data.contributed_repos.info.disabledboolean

Always included.

data.contributed_repos.info.visibilitystring

Always included.

data.contributed_repos.info.pushed_atstringnullable

Always included.

data.contributed_repos.info.created_atstring

Always included.

data.contributed_repos.info.updated_atstring

Always included.

data.contributed_repos.info.urlstring

Always included.

absolute HTTPS URL

data.contributed_repos.info.stars_countinteger

Always included.

≥ 0

data.contributed_repos.info.subscriberCountintegernullableoptional

Optional.

data.contributed_repos.info.networkCountintegernullableoptional

Optional.

data.contributed_repos.info.hasIssuesbooleannullableoptional

Optional.

data.contributed_repos.info.hasDiscussionsbooleannullableoptional

Optional.

data.contributed_repos.info.hasWikibooleannullableoptional

Optional.

data.contributed_repos.info.hasPagesbooleannullableoptional

Optional.

data.contributed_repos.info.isTemplatebooleannullableoptional

Optional.

data.contributed_repos.info.parentRepository.fullNamestring

Always included.

data.contributed_repos.info.parentRepository.urlstring

Always included.

absolute HTTPS URL

Optional.

data.contributed_repos.info.sourceRepository.fullNamestring

Always included.

data.contributed_repos.info.sourceRepository.urlstring

Always included.

absolute HTTPS URL

data.contributed_repos.info.starsintegeroptional

Optional.

≥ 0

data.contributed_repos.info.forksintegeroptional

Optional.

≥ 0

data.contributed_repos.info.open_issuesintegeroptional

Optional.

≥ 0

data.contributed_repos.info.watchersintegernullableoptional

Optional.

data.contributed_repos.releasesobject[]nullable

Always included.

up to 5 items

Always included.

data.own_repos.info.idinteger

Always included.

≥ 0

data.own_repos.info.node_idstring

Always included.

data.own_repos.info.namestring

Always included.

data.own_repos.info.full_namestring

Always included.

data.own_repos.info.owner.idinteger

Always included.

≥ 0

data.own_repos.info.owner.loginstring

Always included.

data.own_repos.info.owner.avatar_urlstring

Always included.

absolute HTTPS URL

data.own_repos.info.owner.urlstring

Always included.

absolute HTTPS URL

data.own_repos.info.owner.typestring

Always included.

data.own_repos.info.privateboolean

Always included.

data.own_repos.info.descriptionstringnullable

Always included.

data.own_repos.info.forkboolean

Always included.

data.own_repos.info.homepagestringnullable

Always included.

data.own_repos.info.languagestringnullable

Always included.

data.own_repos.info.forks_countinteger

Always included.

≥ 0

data.own_repos.info.watchers_countinteger

Always included.

≥ 0

data.own_repos.info.sizeinteger

Always included.

≥ 0

data.own_repos.info.default_branchstring

Always included.

data.own_repos.info.open_issues_countinteger

Always included.

≥ 0

data.own_repos.info.topicsstring[]

Always included.

data.own_repos.info.license.keystring

Always included.

data.own_repos.info.license.namestring

Always included.

data.own_repos.info.license.spdx_idstringnullable

Always included.

data.own_repos.info.archivedboolean

Always included.

data.own_repos.info.disabledboolean

Always included.

data.own_repos.info.visibilitystring

Always included.

data.own_repos.info.pushed_atstringnullable

Always included.

data.own_repos.info.created_atstring

Always included.

data.own_repos.info.updated_atstring

Always included.

data.own_repos.info.urlstring

Always included.

absolute HTTPS URL

data.own_repos.info.stars_countinteger

Always included.

≥ 0

data.own_repos.info.subscriberCountintegernullableoptional

Optional.

data.own_repos.info.networkCountintegernullableoptional

Optional.

data.own_repos.info.hasIssuesbooleannullableoptional

Optional.

data.own_repos.info.hasDiscussionsbooleannullableoptional

Optional.

data.own_repos.info.hasWikibooleannullableoptional

Optional.

data.own_repos.info.hasPagesbooleannullableoptional

Optional.

data.own_repos.info.isTemplatebooleannullableoptional

Optional.

data.own_repos.info.parentRepository.fullNamestring

Always included.

data.own_repos.info.parentRepository.urlstring

Always included.

absolute HTTPS URL

Optional.

data.own_repos.info.sourceRepository.fullNamestring

Always included.

data.own_repos.info.sourceRepository.urlstring

Always included.

absolute HTTPS URL

data.own_repos.info.starsintegeroptional

Optional.

≥ 0

data.own_repos.info.forksintegeroptional

Optional.

≥ 0

data.own_repos.info.open_issuesintegeroptional

Optional.

≥ 0

data.own_repos.info.watchersintegernullableoptional

Optional.

data.own_repos.readmestringnullable

Always included.

data.own_repos.releasesobject[]nullable

Always included.

data.own_repos.top_issues.top_feature_request.idstring

Always included.

data.own_repos.top_issues.top_feature_request.urlstringnullable

Always included.

data.own_repos.top_issues.top_feature_request.contentobject

Always included.

data.own_repos.top_issues.top_feature_request.authorobject

Always included.

data.own_repos.top_issues.top_feature_request.engagementobject

Always included.

data.own_repos.top_issues.top_feature_request.flagsobject

Always included.

data.own_repos.top_issues.top_feature_request.published_atstringnullable

Always included.

data.own_repos.top_issues.top_feature_request.extobjectoptional

Optional.

data.own_repos.top_issues.top_feature_request.numberinteger

Always included.

≥ 0

data.own_repos.top_issues.top_feature_request.titlestring

Always included.

data.own_repos.top_issues.top_feature_request.bodystringnullable

Always included.

data.own_repos.top_issues.top_feature_request.html_urlstring

Always included.

absolute HTTPS URL

data.own_repos.top_issues.top_feature_request.stateenum

Always included.

one of: open, closed

data.own_repos.top_issues.top_feature_request.userobjectnullable

Always included.

data.own_repos.top_issues.top_feature_request.labelsstring | object[]

Always included.

data.own_repos.top_issues.top_feature_request.commentsinteger

Always included.

≥ 0

data.own_repos.top_issues.top_feature_request.created_atstring

Always included.

data.own_repos.top_issues.top_feature_request.updated_atstring

Always included.

data.own_repos.top_issues.top_feature_request.closed_atstringnullable

Always included.

data.own_repos.top_issues.top_feature_request.reactionsobject

Always included.

data.own_repos.top_issues.top_feature_request.postobject

Always included.

data.own_repos.top_issues.top_complaint.idstring

Always included.

data.own_repos.top_issues.top_complaint.urlstringnullable

Always included.

data.own_repos.top_issues.top_complaint.contentobject

Always included.

data.own_repos.top_issues.top_complaint.authorobject

Always included.

data.own_repos.top_issues.top_complaint.engagementobject

Always included.

data.own_repos.top_issues.top_complaint.flagsobject

Always included.

data.own_repos.top_issues.top_complaint.published_atstringnullable

Always included.

data.own_repos.top_issues.top_complaint.extobjectoptional

Optional.

data.own_repos.top_issues.top_complaint.numberinteger

Always included.

≥ 0

data.own_repos.top_issues.top_complaint.titlestring

Always included.

data.own_repos.top_issues.top_complaint.bodystringnullable

Always included.

data.own_repos.top_issues.top_complaint.html_urlstring

Always included.

absolute HTTPS URL

data.own_repos.top_issues.top_complaint.stateenum

Always included.

one of: open, closed

data.own_repos.top_issues.top_complaint.userobjectnullable

Always included.

data.own_repos.top_issues.top_complaint.labelsstring | object[]

Always included.

data.own_repos.top_issues.top_complaint.commentsinteger

Always included.

≥ 0

data.own_repos.top_issues.top_complaint.created_atstring

Always included.

data.own_repos.top_issues.top_complaint.updated_atstring

Always included.

data.own_repos.top_issues.top_complaint.closed_atstringnullable

Always included.

data.own_repos.top_issues.top_complaint.reactionsobject

Always included.

data.own_repos.top_issues.top_complaint.postobject

Always included.

Optional.

data.own_repos.top_issues.mostDiscussedIssue.idstring

Always included.

data.own_repos.top_issues.mostDiscussedIssue.urlstringnullable

Always included.

data.own_repos.top_issues.mostDiscussedIssue.contentobject

Always included.

data.own_repos.top_issues.mostDiscussedIssue.authorobject

Always included.

data.own_repos.top_issues.mostDiscussedIssue.engagementobject

Always included.

data.own_repos.top_issues.mostDiscussedIssue.flagsobject

Always included.

data.own_repos.top_issues.mostDiscussedIssue.published_atstringnullable

Always included.

data.own_repos.top_issues.mostDiscussedIssue.extobjectoptional

Optional.

data.own_repos.top_issues.mostDiscussedIssue.numberinteger

Always included.

≥ 0

data.own_repos.top_issues.mostDiscussedIssue.titlestring

Always included.

data.own_repos.top_issues.mostDiscussedIssue.bodystringnullable

Always included.

data.own_repos.top_issues.mostDiscussedIssue.html_urlstring

Always included.

absolute HTTPS URL

data.own_repos.top_issues.mostDiscussedIssue.stateenum

Always included.

one of: open, closed

data.own_repos.top_issues.mostDiscussedIssue.userobjectnullable

Always included.

data.own_repos.top_issues.mostDiscussedIssue.labelsstring | object[]

Always included.

data.own_repos.top_issues.mostDiscussedIssue.commentsinteger

Always included.

≥ 0

data.own_repos.top_issues.mostDiscussedIssue.created_atstring

Always included.

data.own_repos.top_issues.mostDiscussedIssue.updated_atstring

Always included.

data.own_repos.top_issues.mostDiscussedIssue.closed_atstringnullable

Always included.

data.own_repos.top_issues.mostDiscussedIssue.reactionsobject

Always included.

data.own_repos.top_issues.mostDiscussedIssue.postobject

Always included.

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
400	`invalid_request`	Invalid, duplicate or unsupported parameters.
401	`unauthorized`	Invalid worker key.
404	`not_found`	Public source record unavailable; SocialFetch aliases return data.lookupStatus=not_found with HTTP 200.
429	`upstream_rate_limited`	GitHub throttled retrieval.
502	`upstream_error` `upstream_challenged` `unsupported_page`	Source retrieval failed or the source contract changed.
502	`unsafe_redirect` `response_too_large` `payload_too_complex` `request_limit`	A fixed safety or resource boundary was reached.
503	`busy`	All worker slots are occupied.
504	`timeout`	Total deadline expired.

Code example

curl "https://api.scrapeatlas.com/v1/github/user/profile-velocity?handle=example&depth=quick&sections=summary" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/github/user/profile-velocity?handle=example&depth=quick&sections=summary",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/github/user/profile-velocity?handle=example&depth=quick&sections=summary",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`GitHub request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/github/user/profile-velocity",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "handle": "example",
        "depth": "quick",
        "sections": "summary"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/github/user/profile-velocity?handle=example&depth=quick&sections=summary", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/github/user/profile-velocity?handle=example&depth=quick&sections=summary"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "data": {
    "velocity": {
      "total": 1,
      "merged": 1,
      "open": 1
    },
    "period": {
      "since": null,
      "until": null,
      "basis": "created"
    },
    "sampling": {
      "sections": "summary",
      "authoredPullRequests": 1,
      "externalRepositoryLimit": 5,
      "ownedRepositoryLimit": 3
    },
    "contributed_repos": [],
    "own_repos": []
  },
  "platform": "github",
  "endpoint": "/v1/github/user/profile-velocity",
  "success": true,
  "status": "partial",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "sourceUrl": "https://github.com/example",
  "fetchedAt": "2026-09-17T00:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "complete": false,
    "warnings": [
      "velocity_all_time_totals",
      "competitor_velocity_window_unspecified"
    ]
  },
  "accounting": {
    "upstreamRequests": 3,
    "responseBytes": 1692,
    "durationMs": 1
  }
}

Invalid, duplicate or unsupported parameters.

{
  "success": false,
  "status": "failed",
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  },
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  }
}