Public Data APIs

The Open Humans public data APIs allows you to retrieve JSON representations of publicly available data in Open Humans.

If you plan to use public data, please read our guidelines for using public data.

List endpoints use pagination via the offset querystring parameter; the default page size is 100 results. A smaller or larger page size can be specified with the limit parameter.

DataFile API endpoints

DataFiles (list)

Information for all public DataFiles.

URL path: /api/public/datafiles/

Filter options:

  • datatype_id (integer)
  • source_project_id (integer)
  • username (string)

Examples:

DataFile

Information for an individual public DataFile.

URL path: /api/public/datafile/{id}

Member API endpoints

Members (list)

All active members.

URL path: /api/public/members/

Filter options:

  • name (string) matches as inexact substring
  • username (string) matches as inexact substring

Examples:

Member

Information about an individual member, specified by username.

URL path: /api/public/member/{username}/

Examples:

Member public datafiles (list)

DataFiles a member has publicly shared.

URL path: /api/public/member/{username}/datafiles/

Filter options:

  • datatype_id (integer)
  • source_project_id (integer)
  • username (string)

Member projects (list)

Projects a member has joined. Restricted to visible memberships in approved projects.

URL path: /api/public/member/{username}/projects/

Examples:

Project API endpoints

Projects (list)

All approved projects.

URL path: /api/public/projects/

Filter options:

  • active (boolean)
  • id (integer)
  • name (string)

Examples:

Project

Information about an individual project, specified by ID.

URL path: /api/public/project/{id}/

Examples:

Project public datafiles (list)

Public DataFiles that were produced by this project.

URL path: /api/public/project/{id}/datafiles/

Filter options:

  • datatype_id (integer)
  • source_project_id (integer)
  • username (string)

Examples:

Project members (list)

Members that have joined a project. Restricted to visible memberships in approved projects.

URL path: /api/public/project/{id}/members/

Examples:

DataType API endpoints

DataTypes (list)

All available DataTypes.

URL path: /api/public/datatypes/

Filter options:

  • source_project_id (integer)
  • uploadable (true or false)

Examples:

DataType

Information about an individual DataType, specified by ID.

URL path: /api/public/datatypes/{id}/

Examples:

DataType public datafiles (list)

Public DataFiles that have this DataType.

Optionally includes DataFiles matching any child DataTypes.

URL path: /api/public/project/{id}/datafiles/

Filter options:

  • datatype_id (integer)
  • source_project_id (integer)
  • username (string)
  • include_children (boolean)

Examples:

Legacy endpoints

These are deprecated.

About | Blog | Chat | Member list | Twitter | Facebook | Contact Us | Community Guidelines | Terms of Use | Data Use Policy