API GitHub
GitHub — хостинг открытого исходного кода. repository возвращает звёзды, форки, язык, темы и лицензию одного репозитория; repository_issues, contributors и forks выдают списки того, что относится к репозиторию; search_issues ищет issues и pull requests по всему GitHub; user и user_repositories возвращают данные аккаунта; trending возвращает сегодняшний список трендов.
Для репозитория укажите ссылку или owner/repo, для аккаунта — имя пользователя, а для issue — полную ссылку. Списки возвращают одну страницу до 100 записей (user_repositories — до 30). Переименованные или переданные другому владельцу репозитории возвращаются под новым именем.
Доступность платформы
- Состояние за 24 ч
- Норма
За последние 30 дней
Доступные возможности
Все действия GitHub: что делает каждое, сколько стоит и как работало за последние 24 часа. Откройте действие, чтобы увидеть параметры, поля ответа и примеры кода.
| Возможность | Описание | За 1000 | Состояние за 24 часа |
|---|---|---|---|
Сведения о репозиторииrepository | Получите данные репозитория GitHub по ссылке или owner/repo: звёзды, форки, открытые issues, язык, темы, лицензия, ветка по умолчанию, признаки архивного репозитория и форка, размер, время создания, обновления и последнего пуша. | $0.96 за 1 000 запросов | Норма |
Профиль пользователяuser | Получите публичный профиль пользователя или организации GitHub: имя, био, компания, местоположение, сайт, имя пользователя в X, подписчики, подписки, число публичных репозиториев и гистов, дата регистрации. | $0.96 за 1 000 запросов | Норма |
Репозитории пользователяuser_repositories | Получите до 30 публичных репозиториев одного аккаунта GitHub со звёздами, форками, языком, темами, лицензией и временем последнего пуша, отсортированных по дате создания, обновления, последнего пуша или по имени. | $0.96 за 1 000 запросов | Норма |
Задачи и пул-реквесты репозиторияrepository_issues | Получите issues и pull requests одного репозитория GitHub (открытые, закрытые или все) с номером, заголовком, текстом, метками, числом комментариев и реакций, автором и датами, до 100 за вызов. | $0.96 за 1 000 запросов | Норма |
Поиск задачsearch_issues | Ищите issues и pull requests по всему GitHub с помощью его собственных квалификаторов запроса, например repo:, is:pr или label:, и получайте до 100 совпадений с заголовком, текстом, состоянием, метками, счётчиками, автором и репозиторием. | $1.92 за 1 000 запросов | Норма |
Комментарии к задачеissue_comments | Читайте комментарии к одному issue или pull request на GitHub в порядке публикации, до 100 за вызов, с текстом, автором, ролью автора в репозитории, реакциями и прямой ссылкой. | $0.96 за 1 000 запросов | Норма |
Контрибьюторы репозиторияcontributors | Получите контрибьюторов репозитория GitHub, ранжированных по числу коммитов, до 100 за вызов: имя пользователя, аватар, тип аккаунта и число коммитов. | $0.96 за 1 000 запросов | Норма |
Форки репозиторияforks | Получите форки репозитория GitHub, сначала новые или по числу звёзд, до 100 за вызов, с владельцем, звёздами, форками, языком, темами и временем последнего пуша каждого форка. | $0.96 за 1 000 запросов | Норма |
Трендыtrending | Получите сегодняшний список трендов GitHub, обычно около 14 репозиториев в порядке рейтинга, с владельцем, названием, ссылкой и описанием каждого. | $0.81 за 1 000 запросов | Норма |
Откройте возможность, чтобы посмотреть её параметры, поля ответа и примеры кода, а также попробовать её в работе.
Какие параметры принимает каждое действие API GitHub?
Каждый ответ ниже описывает одно вызываемое действие и его фактические входные данные. Значение параметров и допустимые значения зависят от действия: знакомое имя параметра не обязательно означает одно и то же на всех платформах.
Ссылки на официальные источники приводятся только для пояснения расположенного рядом термина, принятого на платформе. Они не означают, что платформа предоставила разрешение или выразила одобрение. Функции официального сайта не входят в API EveryInfra, если они не перечислены на этой странице.
| Действие | Обязательные | Необязательные | Способ получения результата | Лимит | За 1 000 | Поля ответа |
|---|---|---|---|---|---|---|
repositoryСведения о репозитории Получите данные репозитория GitHub по ссылке или owner/repo: звёзды, форки, открытые issues, язык, темы, лицензия, ветка по умолчанию, признаки архивного репозитория и форка, размер, время создания, обновления и последнего пуша. | url | — | Режим выдачи: Sync | — | $0.96 за 1 000 запросов | id · full_name · name · owner_username · owner_url · owner_avatar_url · url · description · homepage · language · license · topics · star_count · fork_count · open_issue_count · default_branch · is_fork · is_archived · size_kb · created_at · updated_at · pushed_at · platform |
userПрофиль пользователя Получите публичный профиль пользователя или организации GitHub: имя, био, компания, местоположение, сайт, имя пользователя в X, подписчики, подписки, число публичных репозиториев и гистов, дата регистрации. | username | — | Режим выдачи: Sync | — | $0.96 за 1 000 запросов | username · id · display_name · bio · company · location · website · twitter_username · follower_count · following_count · public_repo_count · public_gist_count · avatar_url · url · account_type · created_at · platform |
user_repositoriesРепозитории пользователя Получите до 30 публичных репозиториев одного аккаунта GitHub со звёздами, форками, языком, темами, лицензией и временем последнего пуша, отсортированных по дате создания, обновления, последнего пуша или по имени. | username | sort | Режим выдачи: Sync | Значения в каталоге: defaultLimit=30, maxLimit=30. В некоторых действиях limit задаёт число страниц или число вложенных элементов на родительский объект, поэтому это не всегда итоговое количество записей. | $0.96 за 1 000 запросов | id · full_name · name · owner_username · owner_url · owner_avatar_url · url · description · homepage · language · license · topics · star_count · fork_count · open_issue_count · default_branch · is_fork · is_archived · size_kb · created_at · updated_at · pushed_at · platform |
repository_issuesЗадачи и пул-реквесты репозитория Получите issues и pull requests одного репозитория GitHub (открытые, закрытые или все) с номером, заголовком, текстом, метками, числом комментариев и реакций, автором и датами, до 100 за вызов. | url | sort, state | Режим выдачи: Sync | Значения в каталоге: defaultLimit=30, maxLimit=100. В некоторых действиях limit задаёт число страниц или число вложенных элементов на родительский объект, поэтому это не всегда итоговое количество записей. | $0.96 за 1 000 запросов | id · number · url · title · text · state · is_pull_request · is_draft · labels · comment_count · reaction_count · repository · author_username · author_id · author_avatar_url · author_type · author_association · posted_at · updated_at · closed_at · merged_at · platform |
search_issuesПоиск задач Ищите issues и pull requests по всему GitHub с помощью его собственных квалификаторов запроса, например repo:, is:pr или label:, и получайте до 100 совпадений с заголовком, текстом, состоянием, метками, счётчиками, автором и репозиторием. | keyword | sort | Режим выдачи: Sync | Значения в каталоге: defaultLimit=30, maxLimit=100. В некоторых действиях limit задаёт число страниц или число вложенных элементов на родительский объект, поэтому это не всегда итоговое количество записей. | $1.92 за 1 000 запросов | id · number · url · title · text · state · is_pull_request · is_draft · labels · comment_count · reaction_count · repository · author_username · author_id · author_avatar_url · author_type · author_association · posted_at · updated_at · closed_at · merged_at · platform |
issue_commentsКомментарии к задаче Читайте комментарии к одному issue или pull request на GitHub в порядке публикации, до 100 за вызов, с текстом, автором, ролью автора в репозитории, реакциями и прямой ссылкой. | url | — | Режим выдачи: Sync | Значения в каталоге: defaultLimit=30, maxLimit=100. В некоторых действиях limit задаёт число страниц или число вложенных элементов на родительский объект, поэтому это не всегда итоговое количество записей. | $0.96 за 1 000 запросов | id · url · text · reaction_count · author_username · author_id · author_avatar_url · author_type · author_association · posted_at · updated_at · issue_url · platform |
contributorsКонтрибьюторы репозитория Получите контрибьюторов репозитория GitHub, ранжированных по числу коммитов, до 100 за вызов: имя пользователя, аватар, тип аккаунта и число коммитов. | url | — | Режим выдачи: Sync | Значения в каталоге: defaultLimit=30, maxLimit=100. В некоторых действиях limit задаёт число страниц или число вложенных элементов на родительский объект, поэтому это не всегда итоговое количество записей. | $0.96 за 1 000 запросов | rank · username · id · url · avatar_url · contribution_count · account_type · platform |
forksФорки репозитория Получите форки репозитория GitHub, сначала новые или по числу звёзд, до 100 за вызов, с владельцем, звёздами, форками, языком, темами и временем последнего пуша каждого форка. | url | sort | Режим выдачи: Sync | Значения в каталоге: defaultLimit=30, maxLimit=100. В некоторых действиях limit задаёт число страниц или число вложенных элементов на родительский объект, поэтому это не всегда итоговое количество записей. | $0.96 за 1 000 запросов | id · full_name · name · owner_username · owner_url · owner_avatar_url · owner_type · url · description · homepage · language · topics · star_count · fork_count · open_issue_count · default_branch · is_archived · size_kb · created_at · updated_at · pushed_at · platform |
trendingТренды Получите сегодняшний список трендов GitHub, обычно около 14 репозиториев в порядке рейтинга, с владельцем, названием, ссылкой и описанием каждого. | — | Режим выдачи: Sync | Значения в каталоге: defaultLimit=25, maxLimit=25. В некоторых действиях limit задаёт число страниц или число вложенных элементов на родительский объект, поэтому это не всегда итоговое количество записей. | $0.81 за 1 000 запросов | rank · full_name · owner_username · name · url · description · platform |
Что означают параметры действия repository в API GitHub?
Получите данные репозитория GitHub по ссылке или owner/repo: звёзды, форки, открытые issues, язык, темы, лицензия, ветка по умолчанию, признаки архивного репозитория и форка, размер, время создания, обновления и последнего пуша.
Полный справочник API: параметры, примеры кода, пример ответа и состояниеurlОбязательный- Ссылка на репозиторий GitHub, например
https://github.com/facebook/react, или простоfacebook/react. Дляissue_commentsнужна полная ссылка на issue или pull request, напримерhttps://github.com/openai/whisper/pull/1838. Другие форматы отклоняются до списания средств.GitHub REST API: получение репозитория — В справочнике GitHub REST репозиторий определяется владельцем и названием, а также описаны возвращаемые звёзды, форки, открытые issues, язык, темы, лицензия и время последнего push. Это подтверждает, что означает owner/repo в `url`, но не гарантирует, что у каждого репозитория заполнены все поля. · Проверено
Что означают параметры действия user в API GitHub?
Получите публичный профиль пользователя или организации GitHub: имя, био, компания, местоположение, сайт, имя пользователя в X, подписчики, подписки, число публичных репозиториев и гистов, дата регистрации.
Полный справочник API: параметры, примеры кода, пример ответа и состояниеusernameОбязательный- Имя пользователя GitHub, например
torvalds, или ссылка на профиль; организации тоже поддерживаются.GitHub REST API: получение пользователя — Справочник GitHub REST описывает получение публичного аккаунта по имени пользователя и поля публичного профиля. Это подтверждает, что `username` — это логин GitHub, а не отображаемое имя. · Проверено
Что означают параметры действия user_repositories в API GitHub?
Получите до 30 публичных репозиториев одного аккаунта GitHub со звёздами, форками, языком, темами, лицензией и временем последнего пуша, отсортированных по дате создания, обновления, последнего пуша или по имени.
Полный справочник API: параметры, примеры кода, пример ответа и состояниеusernameОбязательный- Имя пользователя GitHub, например
torvalds, или ссылка на профиль; организации тоже поддерживаются.GitHub REST API: получение пользователя — Справочник GitHub REST описывает получение публичного аккаунта по имени пользователя и поля публичного профиля. Это подтверждает, что `username` — это логин GitHub, а не отображаемое имя. · Проверено sortНеобязательный- Порядок списка.
repository_issues: created (по умолчанию), updated или comments.search_issues: по умолчанию лучшее совпадение, либо comments, created, updated, reactions.forks: newest (по умолчанию), oldest, stargazers, watchers.user_repositories: created, updated, pushed, full_name.Допустимые значения:createdfull_namepushedupdated
Что означают параметры действия repository_issues в API GitHub?
Получите issues и pull requests одного репозитория GitHub (открытые, закрытые или все) с номером, заголовком, текстом, метками, числом комментариев и реакций, автором и датами, до 100 за вызов.
Полный справочник API: параметры, примеры кода, пример ответа и состояниеurlОбязательный- Ссылка на репозиторий GitHub, например
https://github.com/facebook/react, или простоfacebook/react. Дляissue_commentsнужна полная ссылка на issue или pull request, напримерhttps://github.com/openai/whisper/pull/1838. Другие форматы отклоняются до списания средств.GitHub REST API: получение репозитория — В справочнике GitHub REST репозиторий определяется владельцем и названием, а также описаны возвращаемые звёзды, форки, открытые issues, язык, темы, лицензия и время последнего push. Это подтверждает, что означает owner/repo в `url`, но не гарантирует, что у каждого репозитория заполнены все поля. · Проверено sortНеобязательный- Порядок списка.
repository_issues: created (по умолчанию), updated или comments.search_issues: по умолчанию лучшее совпадение, либо comments, created, updated, reactions.forks: newest (по умолчанию), oldest, stargazers, watchers.user_repositories: created, updated, pushed, full_name.Допустимые значения:commentscreatedupdated stateНеобязательный- Состояние issue для
repository_issues: open (по умолчанию), closed или all.Допустимые значения:allclosedopen
Что означают параметры действия search_issues в API GitHub?
Ищите issues и pull requests по всему GitHub с помощью его собственных квалификаторов запроса, например repo:, is:pr или label:, и получайте до 100 совпадений с заголовком, текстом, состоянием, метками, счётчиками, автором и репозиторием.
Полный справочник API: параметры, примеры кода, пример ответа и состояниеkeywordОбязательный- Поисковый запрос по issues GitHub для
search_issues. Поддерживаются квалификаторы GitHub, напримерrepo:openai/whisper is:pr,is:issue label:bugилиauthor:octocat.GitHub Docs: поиск issues и pull requests — В документации GitHub по поиску перечислены квалификаторы, которые можно использовать в поиске issues, например repo:, is:pr, is:issue, label: и author:. Она объясняет, что может содержать `keyword`; число результатов и их порядок определяет сам GitHub. · Проверено sortНеобязательный- Порядок списка.
repository_issues: created (по умолчанию), updated или comments.search_issues: по умолчанию лучшее совпадение, либо comments, created, updated, reactions.forks: newest (по умолчанию), oldest, stargazers, watchers.user_repositories: created, updated, pushed, full_name.Допустимые значения:commentscreatedreactionsupdated
Что означают параметры действия issue_comments в API GitHub?
Читайте комментарии к одному issue или pull request на GitHub в порядке публикации, до 100 за вызов, с текстом, автором, ролью автора в репозитории, реакциями и прямой ссылкой.
Полный справочник API: параметры, примеры кода, пример ответа и состояниеurlОбязательный- Ссылка на репозиторий GitHub, например
https://github.com/facebook/react, или простоfacebook/react. Дляissue_commentsнужна полная ссылка на issue или pull request, напримерhttps://github.com/openai/whisper/pull/1838. Другие форматы отклоняются до списания средств.GitHub REST API: список комментариев к issue — Справочник GitHub REST описывает получение комментариев к issue по репозиторию и номеру и уточняет, что каждый pull request тоже является issue, поэтому ссылки вида issues/<number> и pull/<number> в `url` ведут к одному и тому же обсуждению. Комментарии ревью к строкам кода в него не входят. · Проверено
Что означают параметры действия contributors в API GitHub?
Получите контрибьюторов репозитория GitHub, ранжированных по числу коммитов, до 100 за вызов: имя пользователя, аватар, тип аккаунта и число коммитов.
Полный справочник API: параметры, примеры кода, пример ответа и состояниеurlОбязательный- Ссылка на репозиторий GitHub, например
https://github.com/facebook/react, или простоfacebook/react. Дляissue_commentsнужна полная ссылка на issue или pull request, напримерhttps://github.com/openai/whisper/pull/1838. Другие форматы отклоняются до списания средств.GitHub REST API: получение репозитория — В справочнике GitHub REST репозиторий определяется владельцем и названием, а также описаны возвращаемые звёзды, форки, открытые issues, язык, темы, лицензия и время последнего push. Это подтверждает, что означает owner/repo в `url`, но не гарантирует, что у каждого репозитория заполнены все поля. · Проверено
Что означают параметры действия forks в API GitHub?
Получите форки репозитория GitHub, сначала новые или по числу звёзд, до 100 за вызов, с владельцем, звёздами, форками, языком, темами и временем последнего пуша каждого форка.
Полный справочник API: параметры, примеры кода, пример ответа и состояниеurlОбязательный- Ссылка на репозиторий GitHub, например
https://github.com/facebook/react, или простоfacebook/react. Дляissue_commentsнужна полная ссылка на issue или pull request, напримерhttps://github.com/openai/whisper/pull/1838. Другие форматы отклоняются до списания средств.GitHub REST API: получение репозитория — В справочнике GitHub REST репозиторий определяется владельцем и названием, а также описаны возвращаемые звёзды, форки, открытые issues, язык, темы, лицензия и время последнего push. Это подтверждает, что означает owner/repo в `url`, но не гарантирует, что у каждого репозитория заполнены все поля. · Проверено sortНеобязательный- Порядок списка.
repository_issues: created (по умолчанию), updated или comments.search_issues: по умолчанию лучшее совпадение, либо comments, created, updated, reactions.forks: newest (по умолчанию), oldest, stargazers, watchers.user_repositories: created, updated, pushed, full_name.Допустимые значения:newestoldeststargazerswatchers
Что означают параметры действия trending в API GitHub?
Получите сегодняшний список трендов GitHub, обычно около 14 репозиториев в порядке рейтинга, с владельцем, названием, ссылкой и описанием каждого.
Полный справочник API: параметры, примеры кода, пример ответа и состояниеУ этого действия нет бизнес-параметров. Передайте только идентификаторы платформы и действия.
Как использовать API GitHub
- 01Выберите действие платформы в публичном каталоге.
- 02Передайте платформу, действие и обязательные параметры в POST-запросе на эндпоинт /api/v1/social.
- 03Получите результат из ответа. Для асинхронного действия опрашивайте статус по возвращённому ID задачи.
- 04Сохраните поля ответа, которые нужны вашему приложению.
curl -X POST https://api.everyinfra.com/api/v1/social \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"platform":"github","action":"repository","params":{"url":"<url>"}}'
Вопросы об API GitHub
Какие данные можно получить через API GitHub?
Укажите в platform значение github. В текущем каталоге: сведения о репозитории, профиль пользователя, репозитории пользователя, задачи и пул-реквесты репозитория, поиск задач и more. Эти названия действий соответствуют разным объектам или представлениям GitHub; это не взаимозаменяемые режимы поиска.
Какие входные данные нужны для запроса repository к платформе GitHub?
Ссылка на репозиторий GitHub, например https://github.com/facebook/react, или просто facebook/react. Для issue_comments нужна полная ссылка на issue или pull request, например https://github.com/openai/whisper/pull/1838. Другие форматы отклоняются до списания средств. Передайте это значение в поле url объекта params.
Какие поля может вернуть repository на платформе GitHub?
Объявленная схема включает full_name, name, owner_username и owner_url. Объявленное поле может отсутствовать в отдельной записи, а у каждого другого действия свой список полей.
Все ли действия GitHub возвращают результат сразу?
Действия с пометкой «асинхронное» возвращают ID задачи, по которому нужно опрашивать статус. Любое другое действие тоже можно запустить асинхронно: добавьте "mode": "async" в тело запроса, чтобы сразу получить ID задачи. Это удобно для длительных задач или запросов с большим лимитом. В текущем каталоге: режим выдачи: sync.