Katkı Takvimi

GET/v1/github/user/contributions1 kredi

Bir kullanıcının bir yıllık katkı takvimini döndürür: yıllık toplam ve her gün için katkı sayısı ile yoğunluk seviyesi.

01Sorgu parametreleri

Ad	Tür	Açıklama
handleisteğe bağlı	string	GitHub kullanıcı adı, örneğin `torvalds` (baştaki `@` yok sayılır). `handle`, `username` veya `url` parametrelerinden biri zorunludur.
usernameisteğe bağlı	string	`handle` ile aynıdır, bu adla da kabul edilir. `handle`, `username` veya `url` parametrelerinden biri zorunludur.
urlisteğe bağlı	string	GitHub profil URL'si, örneğin `https://github.com/torvalds`. `handle`, `username` veya `url` parametrelerinden biri zorunludur.
yearisteğe bağlı	integer	Takvim yılı; 2008'den içinde bulunulan yıla kadar. Varsayılan olarak içinde bulunulan yıl kullanılır.

02İstek

curl "https://api.scrapesocial.ai/v1/github/user/contributions?handle=torvalds&year=2024" \
  -H "x-api-key: $SCRAPESOCIAL_KEY"

03Yanıtlar

API'nin gerçek yanıtları. Listeler 2 öğeye kısaltılmıştır.

GET /v1/github/user/contributions?handle=torvalds&year=2024

{
  "success": true,
  "credits_remaining": 4980,
  "credits_charged": 1,
  "contributions": {
    "username": "torvalds",
    "year": 2024,
    "total_contributions": 2892,
    "days": [
      {
        "date": "2024-01-01",
        "contribution_count": 0,
        "color": null,
        "intensity": 0
      },
      {
        "date": "2024-01-02",
        "contribution_count": 0,
        "color": null,
        "intensity": 0
      }
    ]
  }
}

Tüm uç noktalarda ortak

Her rota bunları döndürebilir: eksik ya da hatalı anahtar, biten kredi, yanıt vermeyen platform ya da bizim tarafımızdaki bir hata. Hiçbiri kredi harcamaz.

GET /v1/cosmos/profile?handle=design

{
  "success": false,
  "message": "Invalid API key"
}

04Notlar

Yanıttaki `contributions` nesnesi `total_contributions` ve `days` alanlarını içerir; `days` her zaman tüm takvim yılını kapsar (henüz gelmemiş günler 0 olarak gelir). `intensity`, takvimdeki 0 ile 4 arasındaki renk tonu seviyesidir; `color` her zaman null'dır. Bilinmeyen bir kullanıcı ücretsiz 404 döner; GitHub kullanıcı adı ya da profil URL'si olmayan bir değer ücretsiz 400 döner.

05Hatalar ve krediler

Her hatada success: false ve gerçek bir HTTP durum kodu döner; kredi düşmez.

400missing_parameter
Zorunlu bir parametre eksik veya geçersiz.
403private_account
Hesap gizli ya da yaş kısıtlamalı.
404not_found
Böyle bir hesap yok.
503upstream_error
Platform şu an cevap vermiyor; tekrar deneyin.