You are here

Open edX ReST APIs

 Printer Version PDF Version

Open edX includes a suite of APIs that allow you to build applications that interact with the edX platform.

Open edX APIs use Representational State Transfer (ReST) design principles and support JavaScript Object Notation (JSON) data-interchange format. 

Our APIs use OAuth 2.0 for authentication. OAuth 2.0 is an open standard used by many systems that require secure user authentication. See the OAuth 2.0 Standard for more information.

The Open edX Platform ReST APIs

The Open edX Platform ReST APIs are a rapidly growing and evolving set of capabilities that enable you to build web, desktop, and mobile applications that work with your Open edX instance.

The edX Platform API documentation is deprecated.

Currently the Open edX Platform includes the following APIs.

Enrollment API

Use the Enrollment API to view user and course enrollment information and to enroll a user in a course. This links to the Enrollment API code on GitHub.

User API

Use the User API to view and update user account and preferences information. This links to the User API code on GitHub.

Data Analytics API

Use the Data Analytics API to view and analyze student activity in your course.