edX Contents API

API change history

List of APIs related to external content (edX)

Search edX courses

  1. Search by course title, course description, course key.

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    searched text

  • (optional)
    array

    subject_subjectfilter, availability_availabilityfilter, pacingtype_pacingtypefilter or modularcredits_value. One item per filter.

  • (optional)
    string

    Format - date-time (as date-time in RFC3339). start date of course run

  • (optional)
    string

    Format - date-time (as date-time in RFC3339). end date of course run

  • (optional)
    string

    Accepted populate entities: courseruns

  • (optional)
    string
  • (optional)
    integer

    Format - int32.

  • (optional)
    integer

    Format - int32.

  • (optional)
    string

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Searched courses

Representations

{
  "description": "edX course catalog",
  "type": "object",
  "properties": {
    "uuid": {
      "format": "uuid",
      "description": "The unique identifier for the course. Example: 0dbd8181-8866-47fc...",
      "type": "string"
    },
    "course": {
      "description": "A unique identifier for the course. Example: edX+DemoX.",
      "type": "string"
    },
    "title": {
      "description": "The title of the course.",
      "type": "string"
    },
    "shortDescription": {
      "description": "The short description of the content item and its content.",
      "type": "string"
    },
    "fullDescription": {
      "description": "The long description of the course and its content.",
      "type": "string"
    },
    "contentLanguage": {
      "description": "The language used by the content item.",
      "type": "string"
    },
    "enrollmentUrl": {
      "description": "The URL for the enrollment page.",
      "type": "string"
    },
    "subjects": {
      "description": "The academic subjects that the course covers.",
      "type": "string"
    },
    "owners": {
      "description": "The institution that offers the course.",
      "type": "string"
    },
    "video": {
      "description": "The course About video.",
      "type": "string"
    },
    "image": {
      "description": "The About page image for the course.",
      "type": "string"
    },
    "contentType": {
      "description": "Type of learning item. course, courserun, program",
      "type": "string"
    },
    "marketingUrl": {
      "description": "The URL for the course About page.",
      "type": "string"
    },
    "courseKey": {
      "description": "An identifier for the course. For example, RITx+PM9003x.",
      "type": "string"
    },
    "prerequisites": {
      "description": "Any courses a learner must complete before enrolling in the current course.",
      "type": "string"
    },
    "programs": {
      "description": "Any programs that the course is part of.",
      "type": "string"
    },
    "aggregationKey": {
      "description": "Example: courserun:edX+DemoX.",
      "type": "string"
    },
    "availability": {
      "description": "The course availability current or upcoming.",
      "type": "string"
    },
    "pacingType": {
      "description": "The course pacing type.",
      "type": "string"
    },
    "dyom": {
      "description": "DYOM eligible courses flag.",
      "type": "boolean"
    }
  }
}
{
  "uuid": "string",
  "course": "string",
  "title": "string",
  "shortDescription": "string",
  "fullDescription": "string",
  "contentLanguage": "string",
  "enrollmentUrl": "string",
  "subjects": "string",
  "owners": "string",
  "video": "string",
  "image": "string",
  "contentType": "string",
  "marketingUrl": "string",
  "courseKey": "string",
  "prerequisites": "string",
  "programs": "string",
  "aggregationKey": "string",
  "availability": "string",
  "pacingType": "string",
  "dyom": true
}
{
  "description": "edX course catalog",
  "type": "object",
  "properties": {
    "uuid": {
      "format": "uuid",
      "description": "The unique identifier for the course. Example: 0dbd8181-8866-47fc...",
      "type": "string"
    },
    "course": {
      "description": "A unique identifier for the course. Example: edX+DemoX.",
      "type": "string"
    },
    "title": {
      "description": "The title of the course.",
      "type": "string"
    },
    "shortDescription": {
      "description": "The short description of the content item and its content.",
      "type": "string"
    },
    "fullDescription": {
      "description": "The long description of the course and its content.",
      "type": "string"
    },
    "contentLanguage": {
      "description": "The language used by the content item.",
      "type": "string"
    },
    "enrollmentUrl": {
      "description": "The URL for the enrollment page.",
      "type": "string"
    },
    "subjects": {
      "description": "The academic subjects that the course covers.",
      "type": "string"
    },
    "owners": {
      "description": "The institution that offers the course.",
      "type": "string"
    },
    "video": {
      "description": "The course About video.",
      "type": "string"
    },
    "image": {
      "description": "The About page image for the course.",
      "type": "string"
    },
    "contentType": {
      "description": "Type of learning item. course, courserun, program",
      "type": "string"
    },
    "marketingUrl": {
      "description": "The URL for the course About page.",
      "type": "string"
    },
    "courseKey": {
      "description": "An identifier for the course. For example, RITx+PM9003x.",
      "type": "string"
    },
    "prerequisites": {
      "description": "Any courses a learner must complete before enrolling in the current course.",
      "type": "string"
    },
    "programs": {
      "description": "Any programs that the course is part of.",
      "type": "string"
    },
    "aggregationKey": {
      "description": "Example: courserun:edX+DemoX.",
      "type": "string"
    },
    "availability": {
      "description": "The course availability current or upcoming.",
      "type": "string"
    },
    "pacingType": {
      "description": "The course pacing type.",
      "type": "string"
    },
    "dyom": {
      "description": "DYOM eligible courses flag.",
      "type": "boolean"
    }
  }
}
{
  "uuid": "string",
  "course": "string",
  "title": "string",
  "shortDescription": "string",
  "fullDescription": "string",
  "contentLanguage": "string",
  "enrollmentUrl": "string",
  "subjects": "string",
  "owners": "string",
  "video": "string",
  "image": "string",
  "contentType": "string",
  "marketingUrl": "string",
  "courseKey": "string",
  "prerequisites": "string",
  "programs": "string",
  "aggregationKey": "string",
  "availability": "string",
  "pacingType": "string",
  "dyom": true
}
{
  "description": "edX course catalog",
  "type": "object",
  "properties": {
    "uuid": {
      "format": "uuid",
      "description": "The unique identifier for the course. Example: 0dbd8181-8866-47fc...",
      "type": "string"
    },
    "course": {
      "description": "A unique identifier for the course. Example: edX+DemoX.",
      "type": "string"
    },
    "title": {
      "description": "The title of the course.",
      "type": "string"
    },
    "shortDescription": {
      "description": "The short description of the content item and its content.",
      "type": "string"
    },
    "fullDescription": {
      "description": "The long description of the course and its content.",
      "type": "string"
    },
    "contentLanguage": {
      "description": "The language used by the content item.",
      "type": "string"
    },
    "enrollmentUrl": {
      "description": "The URL for the enrollment page.",
      "type": "string"
    },
    "subjects": {
      "description": "The academic subjects that the course covers.",
      "type": "string"
    },
    "owners": {
      "description": "The institution that offers the course.",
      "type": "string"
    },
    "video": {
      "description": "The course About video.",
      "type": "string"
    },
    "image": {
      "description": "The About page image for the course.",
      "type": "string"
    },
    "contentType": {
      "description": "Type of learning item. course, courserun, program",
      "type": "string"
    },
    "marketingUrl": {
      "description": "The URL for the course About page.",
      "type": "string"
    },
    "courseKey": {
      "description": "An identifier for the course. For example, RITx+PM9003x.",
      "type": "string"
    },
    "prerequisites": {
      "description": "Any courses a learner must complete before enrolling in the current course.",
      "type": "string"
    },
    "programs": {
      "description": "Any programs that the course is part of.",
      "type": "string"
    },
    "aggregationKey": {
      "description": "Example: courserun:edX+DemoX.",
      "type": "string"
    },
    "availability": {
      "description": "The course availability current or upcoming.",
      "type": "string"
    },
    "pacingType": {
      "description": "The course pacing type.",
      "type": "string"
    },
    "dyom": {
      "description": "DYOM eligible courses flag.",
      "type": "boolean"
    }
  }
}

400 Bad Request

Bad Request

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

403 Forbidden

Login user not authorized to perform this action

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

500 Internal Server Error

Server Error

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

Code samples

@ECHO OFF

curl -v -X GET "https://luminus.azure-api.net/ExternalLinks/searchedXCourseCatalog?SearchText={string}&selectedquery={array}&startDate={string}&endDate={string}&populate={string}&sortby={string}&offset={integer}&limit={integer}&where={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["SearchText"] = "{string}";
            queryString["selectedquery"] = "{array}";
            queryString["startDate"] = "{string}";
            queryString["endDate"] = "{string}";
            queryString["populate"] = "{string}";
            queryString["sortby"] = "{string}";
            queryString["offset"] = "{integer}";
            queryString["limit"] = "{integer}";
            queryString["where"] = "{string}";
            var uri = "https://luminus.azure-api.net/ExternalLinks/searchedXCourseCatalog?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://luminus.azure-api.net/ExternalLinks/searchedXCourseCatalog");

            builder.setParameter("SearchText", "{string}");
            builder.setParameter("selectedquery", "{array}");
            builder.setParameter("startDate", "{string}");
            builder.setParameter("endDate", "{string}");
            builder.setParameter("populate", "{string}");
            builder.setParameter("sortby", "{string}");
            builder.setParameter("offset", "{integer}");
            builder.setParameter("limit", "{integer}");
            builder.setParameter("where", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "SearchText": "{string}",
            "selectedquery": "{array}",
            "startDate": "{string}",
            "endDate": "{string}",
            "populate": "{string}",
            "sortby": "{string}",
            "offset": "{integer}",
            "limit": "{integer}",
            "where": "{string}",
        };
      
        $.ajax({
            url: "https://luminus.azure-api.net/ExternalLinks/searchedXCourseCatalog?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://luminus.azure-api.net/ExternalLinks/searchedXCourseCatalog";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"SearchText={string}",
                         @"selectedquery={array}",
                         @"startDate={string}",
                         @"endDate={string}",
                         @"populate={string}",
                         @"sortby={string}",
                         @"offset={integer}",
                         @"limit={integer}",
                         @"where={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://luminus.azure-api.net/ExternalLinks/searchedXCourseCatalog');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'SearchText' => '{string}',
    'selectedquery' => '{array}',
    'startDate' => '{string}',
    'endDate' => '{string}',
    'populate' => '{string}',
    'sortby' => '{string}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'where' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'SearchText': '{string}',
    'selectedquery': '{array}',
    'startDate': '{string}',
    'endDate': '{string}',
    'populate': '{string}',
    'sortby': '{string}',
    'offset': '{integer}',
    'limit': '{integer}',
    'where': '{string}',
})

try:
    conn = httplib.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/ExternalLinks/searchedXCourseCatalog?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'SearchText': '{string}',
    'selectedquery': '{array}',
    'startDate': '{string}',
    'endDate': '{string}',
    'populate': '{string}',
    'sortby': '{string}',
    'offset': '{integer}',
    'limit': '{integer}',
    'where': '{string}',
})

try:
    conn = http.client.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/ExternalLinks/searchedXCourseCatalog?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://luminus.azure-api.net/ExternalLinks/searchedXCourseCatalog')

query = URI.encode_www_form({
    # Request parameters
    'SearchText' => '{string}',
    'selectedquery' => '{array}',
    'startDate' => '{string}',
    'endDate' => '{string}',
    'populate' => '{string}',
    'sortby' => '{string}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'where' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body