GitHub v3 REST API

Tag

object

Tag

namestringrequired

Example:v0.1

commitobjectrequired
Show Child Parameters
zipball_urlstring(uri)required

Example:https://github.com/octocat/Hello-World/zipball/v0.1

tarball_urlstring(uri)required

Example:https://github.com/octocat/Hello-World/tarball/v0.1

node_idstringrequired
Example

Topic

object

A topic aggregates entities that are related to a subject.

namesarray[string]required
Example

Search Result Text Matches

array
object_urlstring
object_typestring
propertystring
fragmentstring
matchesarray[object]
Show Child Parameters

Code Search Result Item

object

Code Search Result Item

namestringrequired
pathstringrequired
shastringrequired
urlstring(uri)required
git_urlstring(uri)required
html_urlstring(uri)required
repositoryobjectrequired

Minimal Repository

Show Child Parameters
scorenumberrequired
file_sizeinteger
languagestring
last_modified_atstring(date-time)
line_numbersarray[string]

Example:73..77, 77..78

text_matchesarray[object]
Show Child Parameters
Example

Commit Search Result Item

object

Commit Search Result Item

urlstring(uri)required
shastringrequired
html_urlstring(uri)required
comments_urlstring(uri)required
commitobjectrequired
Show Child Parameters
authorobjectrequired

Simple User

Show Child Parameters
committerobjectrequired

Metaproperties for Git author/committer information.

Show Child Parameters
parentsarray[object]required
Show Child Parameters
repositoryobjectrequired

Minimal Repository

Show Child Parameters
scorenumberrequired
node_idstringrequired
text_matchesarray[object]
Show Child Parameters
Example