/edx/programs

POST /api/edx/programs

Price: 5 credits

Get full edX (edx.org) program details (Professional Certificate, MicroMasters, MicroBachelors, XSeries, etc.) by program UUID, program page URL, or URL slug.

How to use it

Get full details of a single edX (edx.org) program (Professional Certificate, MicroMasters, MicroBachelors, XSeries, Professional Program) by UUID, program page URL, or URL slug. Returns id, name, subtitle, program_type, overview, marketing_hook, subjects, skills, expected_learning, job_outlook, faq, member courses (with per-course price), partners, staff, image, banner_image, video_url, weeks_to_complete, min_effort/max_effort, price, discounted_price, currency, enrollment_count, availability, languages and web_url. Resolve programs 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)
• program string required — Program UUID, program page URL, or program URL slug. (examples: "94340239-561b-49ce-b1fc-991a1ed4f227", "masters/micromasters/mitx-statistics-and-data-science-social-sciences-track", "https://www.edx.org/certificates/professional-certificate/harvardx-data-science"; minLength: 1)

Response

• @type string (default: "EdxProgram")
• id string required
• name string required
• subtitle string nullable
• program_type string nullable
• overview string nullable
• marketing_hook string nullable
• subjects array (default: [])
• skills array (default: [])
• expected_learning array (default: [])
• job_outlook array (default: [])
• faq array (default: [])
  • @type string (default: "EdxProgramFaq")
  • question string nullable
  • answer string nullable
• courses array (default: [])
  • @type string (default: "EdxProgramCourse")
  • id string required
  • key string nullable
  • name string required
  • price number nullable
  • currency string nullable
• corporate_endorsements array (default: [])
  • @type string (default: "EdxCorporateEndorsement")
  • corporation_name string nullable
  • statement string nullable
  • endorsements array (default: [])
    • @type string (default: "EdxIndividualEndorsement")
    • quote string nullable
    • endorser_name string nullable
    • endorser_title 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
• staff 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
• banner_image string nullable
• video_url string nullable
• weeks_to_complete integer nullable
• weeks_to_complete_min integer nullable
• weeks_to_complete_max integer nullable
• min_effort integer nullable
• max_effort integer nullable
• price number nullable
• discounted_price number nullable
• currency string nullable
• enrollment_count integer nullable
• recent_enrollment_count integer nullable
• availability array (default: [])
• languages array (default: [])
• 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 — Program 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.