Search for repositories

GET

/repos/search

const url = 'https://gitea.com/api/v1/repos/search';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://gitea.com/api/v1/repos/search \
  --header 'Authorization: Basic <credentials>'

Authorizations

Parameters

Query Parameters

string

Keyword

topic

boolean

Limit search to repositories with keyword as topic

includeDesc

boolean

Include search of keyword within repository description

uid

integer format: int64

Search only for repos that the user with the given id owns or contributes to

priority_owner_id

integer format: int64

Repo owner to prioritize in the results

team_id

integer format: int64

Search only for repos that belong to the given team id

starredBy

integer format: int64

Search only for repos that the user with the given id has starred

private

boolean

Include private repositories this user has access to (defaults to true)

is_private

boolean

Show only pubic, private or all repositories (defaults to all)

template

boolean

Include template repositories this user has access to (defaults to true)

archived

boolean

Show only archived, non-archived or all repositories (defaults to all)

mode

string

Type of repository to search for. Supported values are “fork”, “source”, “mirror” and “collaborative”

exclusive

boolean

If uid is given, search only for repos that the user owns

sort

string

Sort repos by attribute. Supported values are “alpha”, “created”, “updated”, “size”, “git_size”, “lfs_size”, “stars”, “forks” and “id”. Default is “alpha”

order

string

Sort order, either “asc” (ascending) or “desc” (descending). Default is “asc”, ignored if “sort” is not specified.

page

integer

Page number of results to return (1-based)

limit

integer

Page size of results

Responses

200

SearchResults

application/json

SearchResults results of a successful search

object

data

Data contains the repository search results

Array<object>

Repository represents a repository

object

allow_fast_forward_only_merge

boolean

allow_manual_merge

boolean

allow_merge_commits

boolean

allow_merge_update

boolean

allow_rebase

boolean

allow_rebase_explicit

boolean

allow_rebase_update

boolean

allow_squash_merge

boolean

archived

boolean

archived_at

string format: date-time

autodetect_manual_merge

boolean

avatar_url

string format: uri

branch_count

integer format: int64

clone_url

string format: uri

created_at

string format: date-time

default_allow_maintainer_edit

boolean

default_branch

string

default_delete_branch_after_merge

boolean

default_merge_style

string

default_target_branch

string

default_update_style

string

description

string

empty

boolean

external_tracker

ExternalTracker represents settings for external tracker

object

external_tracker_format

External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.

string

external_tracker_regexp_pattern

External Issue Tracker issue regular expression

string

external_tracker_style

External Issue Tracker Number Format, either numeric, alphanumeric, or regexp

string

external_tracker_url

URL of external issue tracker.

string format: uri

external_wiki

ExternalWiki represents setting for external wiki

object

external_wiki_url

URL of external wiki.

string format: uri

fork

boolean

forks_count

integer format: int64

full_name

string

has_actions

boolean

has_code

boolean

has_issues

boolean

has_packages

boolean

has_projects

boolean

has_pull_requests

boolean

has_releases

boolean

has_wiki

boolean

html_url

string format: uri

integer format: int64

ignore_whitespace_conflicts

boolean

internal

boolean

internal_tracker

InternalTracker represents settings for internal tracker

object

allow_only_contributors_to_track_time

Let only contributors track time (Built-in issue tracker)

boolean

enable_issue_dependencies

Enable dependencies for issues and pull requests (Built-in issue tracker)

boolean

enable_time_tracker

Enable time tracking (Built-in issue tracker)

boolean

language

string

languages_url

string format: uri

licenses

Array<string>

link

string

mirror

boolean

mirror_interval

string

mirror_last_sync_at

string format: date-time

mirror_updated

string format: date-time

name

string

object_format_name

ObjectFormatName of the underlying git repository sha1 ObjectFormatSHA1 sha256 ObjectFormatSHA256

string

Allowed values: sha1 sha256

open_issues_count

integer format: int64

open_pr_counter

integer format: int64

original_url

string format: uri

owner

User represents a user

object

active

Is user active

boolean

avatar_url

URL to the user’s avatar

string format: uri

created

string format: date-time

description

The user’s description

string

email

string format: email

followers_count

User counts

integer format: int64

following_count

integer format: int64

full_name

The user’s full name

string

html_url

URL to the user’s gitea page

string format: uri

The user’s id

integer format: int64

is_admin

Is the user an administrator

boolean

language

User locale

string

last_login

string format: date-time

location

The user’s location

string

login

string

login_name

Identifier of the user, provided by the external authenticator (if configured)

string

default: empty

prohibit_login

Is user login prohibited

boolean

restricted

Is user restricted

boolean

source_id

The ID of the user’s Authentication Source

integer format: int64

starred_repos_count

integer format: int64

visibility

User visibility level option: public, limited, private public UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate

string

Allowed values: public limited private

website

The user’s website

string

parent

object recursive

permissions

Permission represents a set of permissions

object

admin

boolean

pull

boolean

push

boolean

private

boolean

projects_mode

string

release_counter

integer format: int64

repo_transfer

RepoTransfer represents a pending repo transfer

object

doer

User represents a user

object

active

Is user active

boolean

avatar_url

URL to the user’s avatar

string format: uri

created

string format: date-time

description

The user’s description

string

email

string format: email

followers_count

User counts

integer format: int64

following_count

integer format: int64

full_name

The user’s full name

string

html_url

URL to the user’s gitea page

string format: uri

The user’s id

integer format: int64

is_admin

Is the user an administrator

boolean

language

User locale

string

last_login

string format: date-time

location

The user’s location

string

login

string

login_name

Identifier of the user, provided by the external authenticator (if configured)

string

default: empty

prohibit_login

Is user login prohibited

boolean

restricted

Is user restricted

boolean

source_id

The ID of the user’s Authentication Source

integer format: int64

starred_repos_count

integer format: int64

visibility

User visibility level option: public, limited, private public UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate

string

Allowed values: public limited private

website

The user’s website

string

recipient

User represents a user

object

active

Is user active

boolean

avatar_url

URL to the user’s avatar

string format: uri

created

string format: date-time

description

The user’s description

string

email

string format: email

followers_count

User counts

integer format: int64

following_count

integer format: int64

full_name

The user’s full name

string

html_url

URL to the user’s gitea page

string format: uri

The user’s id

integer format: int64

is_admin

Is the user an administrator

boolean

language

User locale

string

last_login

string format: date-time

location

The user’s location

string

login

string

login_name

Identifier of the user, provided by the external authenticator (if configured)

string

default: empty

prohibit_login

Is user login prohibited

boolean

restricted

Is user restricted

boolean

source_id

The ID of the user’s Authentication Source

integer format: int64

starred_repos_count

integer format: int64

visibility

User visibility level option: public, limited, private public UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate

string

Allowed values: public limited private

website

The user’s website

string

teams

Array<object>

Team represents a team in an organization

object

can_create_org_repo

Whether the team can create repositories in the organization

boolean

description

The description of the team

string

The unique identifier of the team

integer format: int64

includes_all_repositories

Whether the team has access to all repositories in the organization

boolean

name

The name of the team

string

organization

Organization represents an organization

object

avatar_url

The URL of the organization’s avatar

string format: uri

description

The description of the organization

string

email

The email address of the organization

string

full_name

The full display name of the organization

string

The unique identifier of the organization

integer format: int64

location

The location of the organization

string

name

The name of the organization

string

repo_admin_change_team_access

Whether repository administrators can change team access

boolean

username

Username of the organization deprecated

string

visibility

The visibility level of the organization (public, limited, private) public UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate

string

Allowed values: public limited private

website

The website URL of the organization

string

permission

string

Allowed values: none read write admin owner

units

Array<string>

units_map

object

key

additional properties

string

visibility

Team visibility within the organization. “private” teams are only listable by members and org owners; “limited” teams are listable by any organization member; “public” teams are listable by any signed-in user. public TeamVisibilityPublic limited TeamVisibilityLimited private TeamVisibilityPrivate

string

Allowed values: public limited private

size

integer format: int64

ssh_url

string format: uri

stars_count

integer format: int64

template

boolean

topics

Array<string>

updated_at

string format: date-time

url

string format: uri

watchers_count

integer format: int64

website

string

OK indicates if the search was successful

boolean

Example

{
  "data": [
    {
      "object_format_name": "sha1",
      "owner": {
        "login_name": "empty",
        "visibility": "public"
      },
      "repo_transfer": {
        "doer": {
          "login_name": "empty",
          "visibility": "public"
        },
        "recipient": {
          "login_name": "empty",
          "visibility": "public"
        },
        "teams": [
          {
            "organization": {
              "visibility": "public"
            },
            "permission": "none",
            "units": [
              "repo.code",
              "repo.issues",
              "repo.ext_issues",
              "repo.wiki",
              "repo.pulls",
              "repo.releases",
              "repo.projects",
              "repo.ext_wiki"
            ],
            "units_map": {
              "repo.code": "read",
              "repo.ext_issues": "none",
              "repo.ext_wiki": "none",
              "repo.issues": "write",
              "repo.projects": "none",
              "repo.pulls": "owner",
              "repo.releases": "none",
              "repo.wiki": "admin"
            },
            "visibility": "public"
          }
        ]
      }
    }
  ]
}

422

APIValidationError is error format response related to input validation

Headers

message

string

url

string