/edx/courses

POST /api/edx/courses

Price: 5 credits

Get full edX (edx.org) course details by course UUID, course page URL, or URL slug.

How to use it

Get full details of a single edX (edx.org) course by UUID, course page URL, or URL slug. Returns id, key, name, alias, short_description, full_description, overview, level, subjects, skills, prerequisites, syllabus, faq, testimonials, partners (school/university), instructors, image, video_url, rating, rating_count, enrollment_count, languages, price, currency, weeks_to_complete, min_effort/max_effort (hours per week), pacing_type, availability, parent programs, and course_runs (per-session schedule with start/end dates, seats/prices, instructors). Resolve courses via the search endpoint.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• course string required — Course UUID, course page URL, or course URL slug. (examples: "8f8e5124-1dab-47e6-8fa6-3fbdc0738f0a", "learn/web-development/harvard-university-cs50-s-web-programming-with-python-and-javascript", "https://www.edx.org/learn/computer-science/harvard-university-cs50-s-introduction-to-computer-science"; minLength: 1)

Response

• @type string (default: "EdxCourse")
• id string required
• key string nullable
• name string required
• alias string nullable
• short_description string nullable
• full_description string nullable
• overview string nullable
• level string nullable
• subjects array (default: [])
• skills array (default: [])
• prerequisites string nullable
• syllabus string nullable
• faq string nullable
• additional_information string nullable
• testimonials string nullable
• partners array (default: [])
  • @type string (default: "EdxPartner")
  • name string required
  • key string nullable
  • id string nullable
  • alias string nullable
  • image string nullable
  • description string nullable
• instructors array (default: [])
  • @type string (default: "EdxInstructor")
  • id string nullable
  • name string required
  • position string nullable
  • alias string nullable
  • bio_url string nullable
  • image string nullable
  • organization string nullable
• image string nullable
• video_url string nullable
• rating number nullable
• rating_count integer nullable
• enrollment_count integer nullable
• recent_enrollment_count integer nullable
• languages array (default: [])
• price number nullable
• currency string nullable
• weeks_to_complete integer nullable
• min_effort integer nullable
• max_effort integer nullable
• pacing_type string nullable
• availability array (default: [])
• programs array (default: [])
  • @type string (default: "EdxCourseProgramRef")
  • id string required
  • name string required
  • program_type string nullable
  • web_url string nullable
• course_runs array (default: [])
  • @type string (default: "EdxCourseRun")
  • id string nullable
  • key string nullable
  • pacing_type string nullable
  • availability string nullable
  • is_enrollable boolean nullable
  • is_marketable boolean nullable
  • start_at integer nullable
  • end_at integer nullable
  • enrollment_start_at integer nullable
  • enrollment_end_at integer nullable
  • weeks_to_complete integer nullable
  • min_effort integer nullable
  • max_effort integer nullable
  • price number nullable
  • currency string nullable
  • enrollment_count integer nullable
  • marketing_url string nullable
  • enrollment_url string nullable
  • transcript_languages array (default: [])
  • seats array (default: [])
    • @type string (default: "EdxSeat")
    • seat_type string nullable
    • price number nullable
    • currency string nullable
    • sku string nullable
  • instructors array (default: [])
    • @type string (default: "EdxInstructor")
    • id string nullable
    • name string required
    • position string nullable
    • alias string nullable
    • bio_url string nullable
    • image string nullable
    • organization string nullable
• web_url string nullable
• created_at integer nullable
• updated_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Course not found. Verify the UUID, URL, or slug. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.