API

Introduction

API always returns a list of packages. Package is a dictionary of the following format:

{
	"repo": "freebsd",
	"name": "firefox",
	"version": "50.1.0",
	"origversion": "50.1.0_4,1",
	"status": "newest",
	"summary": "Widely used web browser",
	"categories": ["www"],
	"licenses": ["GPLv2+"],
	"maintainers": ["gecko@FreeBSD.org"],
	"www": ["http://www.mozilla.com/firefox"],
	"downloads": ["http://download.cdn.mozilla.net/pub/firefox/releases/50.1.0/source/firefox-50.1.0.source.tar.xz"]
}

Fields are:

repo
name of repository for this package
subrepo
name of subrepository (if applicable; for example, main or contrib or non-free for Debian)
name
package name as in repository (if different from version)
version
package version (sanitized)
origversion
package version as in repository
status
package status, one of newest, devel, unique, outdated, legacy, rolling, noscheme, incorrect, untrusted, ignored
summary
one-line description of the package
categories
list of package categories
licenses
list of package licenses
maintainers
list of package maintainers
www
list of package webpages
downloads
list of package downloads

Mandatory fields are repo, name and version, all other fields are optional.

Project is a group of related packages from different repositories (though it may contain multiple packages from the same repository). Project has its own name which is derived from package names. In most cases it's the same, but sometimes different package names are transformed into a single project name to coalesce differently named packages from different repositories.

API allows to request packages for a single project or for a range of projects.

Single project

Get list of packages for specific project (here, firefox):

/api/v1/project/firefox

Multiple projects

The following requests return data for multiple projects in form of project name → list of packages dictionary. API returns no more than 200 projects per request. You may specify a start or an end of project names range to request.

Get first 200 projects:

/api/v1/projects/

Get first 200 projects starting with firefox (inclusive):

/api/v1/projects/firefox/

Get last 200 projects up to firefox (inclusive):

/api/v1/projects/..firefox/

You may iterate through all projects by using the last project name in the next request

/api/v1/projects/  # returns '010editor' ... 'aaut'
/api/v1/projects/aaut/  # returns 'aaut' ... 'acf-snort'
/api/v1/projects/acf-snort/  # returns 'acf-snort' ... 'adinatha-fonts'
# ...

Filtered projects

API supports all the filters available on the website, so you can just play with filters in the website and then replace /projects/ URL prefix with /api/v1/projects/ to get API output.

Supported filters are:

search
project name substring to look for
maintainer
return projects maintainer by specified person
category
return projects with specified category
inrepo
return projects present in specified repository
notinrepo
return projects absent in specified repository
repos
return projects present in specified number of repositories (exact values and open/closed ranges are allowed, e.g. 1, 5-, -5, 2-7
families
return projects present in specified number of repository families (for instance, use 1 to get unique projects)
repos_newest
return projects which are up to date in specified number of repositories
families_newest
return projects which are up to date in specified number of repository families
newest
return newest projects only
outdated
return outdated projects only
problematic
return problematic projects only

Example: get unique outdated projects not present in FreeBSD maintainer by foo@bar.com

/api/v1/projects/?notinrepo=freebsd&maintainer=foo%40bar.com&families=1&outdated=1

Problems

Get problems for specific repository or maintainer:

/api/v1/repository/freebsd/problems
/api/v1/maintainer/ports@freebsd.org/problems
Output is an array of entries of the following format:
{
	"repo": "freebsd",
	"name": "abby",
	"effname": "abby",
	"maintainer": "ports@freebsd.org",
	"problem": "Homepage link \"https://code.google.com/archive/p/abby/\" points to Google Code which was discontinued. The link should be updated (probably along with download URLs). If this link is still alive, it may point to a new project homepage."
}

Fields are:

repo
repository name
name
package name as in repository
effname
repology project name
maintainer
package maintainer associated with the problem; may be null; note that if there are multiple package maintainers, problem is duplicated for each one
problem
textual description of the problem