/edx/programs/search

POST /api/edx/programs/search

Price: 10 credits

Search and filter the edX (edx.org) program catalog (Professional Certificate, MicroMasters, MicroBachelors, XSeries, Professional Program). Combine a free-text query with program type, subject, level, language, availability, and educator/school filters. Each result is a program summary card.

How to use it

Faceted search over the edX (edx.org) program catalog. Filter by program_type (Professional Certificate/MicroMasters/MicroBachelors/XSeries/Professional Program/Certificate), subject, level, language (primary), translation_language (subtitles), availability (Current/Upcoming/Archived), skill (taught skill), and partner (educator/school). Returns id, name, alias, product_type, short_description, levels, subjects, skills, tags, partners, image, price, currency, availability, course_count and web_url. Use the programs endpoint with a result id for full details.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string — Free-text search over program title and description (default: ""; examples: "data science", "cybersecurity")
• count integer required — Max number of programs to return (min: 1)
• program_type string nullable — Program type / credential (one of: "Professional Certificate", "MicroMasters", "MicroBachelors", "XSeries", "Professional Program", "Certificate")
• subject string nullable — Subject / topic area (one of: "Architecture", "Art & Culture", "Artificial Intelligence", "Biology & Life Sciences", "Business & Management", "Chemistry", "Communication", "Computer Science", "Data Analysis & Statistics", "Design", "Economics & Finance", "Education & Teacher Training", "Electronics", "Energy & Earth Sciences", "Engineering", "Environmental Studies", "Ethics", "Food & Nutrition", "Health & Safety", "History", "Humanities", "Language", "Law", "Literature", "Math", "Medicine", "Music", "Philanthropy", "Philosophy & Ethics", "Physics", "Science", "Social Sciences", "Sustainability")
• level string nullable — Difficulty level (one of: "Introductory", "Intermediate", "Advanced")
• language string nullable — Primary program language (one of: "Arabic", "Bengali", "Chinese", "Dutch", "English", "French", "German", "Hungarian", "Italian", "Japanese", "Korean", "Persian", "Portuguese", "Russian", "Spanish")
• translation_language string nullable — Available subtitle / translation language (one of: "Arabic", "Chinese - China", "English", "French", "German - Germany", "Greek", "Hindi", "Indonesian", "Italian - Italy", "Portuguese - Brazil", "Russian", "Spanish", "Spanish - Latin America and Caribbean", "Spanish - Spain (Modern)", "Thai")
• availability string nullable — Enrollment availability (one of: "Current", "Upcoming", "Archived")
• skill string nullable — Taught skill (e.g. 'Python (Programming Language)', 'Management')
• partner string nullable — Educator / school name (e.g. 'Harvard University', 'MIT')

Response

• @type string (default: "EdxProductSummary")
• id string required
• name string required
• alias string nullable
• product string nullable
• product_type string nullable
• short_description string nullable
• full_description string nullable
• levels array (default: [])
• subjects array (default: [])
• skills array (default: [])
• tags array (default: [])
• partners array (default: [])
• partner_keys array (default: [])
• image string nullable
• languages array (default: [])
• price number nullable
• strikethrough_price number nullable
• currency string nullable
• availability array (default: [])
• weeks_to_complete integer nullable
• min_effort integer nullable
• max_effort integer nullable
• recent_enrollment_count integer nullable
• course_count integer nullable
• is_part_of_program boolean nullable
• web_url string 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 — The entity was not found, or a precondition failed 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.