Github API - Test Config

GET /search/code
search

Searches for query terms inside of a file. This method returns up to 100 results per page.

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

q=addClass+in:file+language:js+repo:jquery/jquery

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

Considerations for code search

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

  • Only the default branch is considered. In most cases, this will be the master branch.
  • Only files smaller than 384 KB are searchable.
  • You must always include at least one search term when searching source code. For example, searching for language:go is not valid, while amazing language:go is.
    Search code

Arguments
q string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

sort string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

key order

order [scalar]

Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

API:
Github Open API
(version: 1.1.4)

key per-page

per-page [scalar]

The number of results per page (max 100).

API:
Github Open API
(version: 1.1.4)

key page

page [scalar]

Page number of the results to fetch.

API:
Github Open API
(version: 1.1.4)

Returns
200 application/json 3893

3893 [object]

Attributes
incomplete_results boolean

total_count integer

API:
Github Open API
(version: 1.1.4)
304 not_modified

not_modified [scalar]

Not modified

API:
Github Open API
(version: 1.1.4)
403 forbidden

forbidden [scalar]

Forbidden

API:
Github Open API
(version: 1.1.4)
422 validation_failed

validation_failed [scalar]

Validation failed, or the endpoint has been spammed.

API:
Github Open API
(version: 1.1.4)
503 service_unavailable

service_unavailable [scalar]

Service unavailable

API:
Github Open API
(version: 1.1.4)
API:
Github Open API
(version: 1.1.4)