POST /api/educanada/programs
Price: 10 credits
Get one Canadian study programme by its EduCanada id with its estimated yearly cost of study: the institution, city and province, tuition and program fees, compulsory fees, books and supplies, and the living costs for shelter, groceries, miscellaneous items and local transport, with subtotals and the yearly total in Canadian dollars.
One programme and its estimated yearly cost of study by the `programme_id` educanada/programs/search returns. For several programmes at once use educanada/programs/costs.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)id string required — EduCanada programme id, as returned by educanada/programs/search (examples: "56453")living_status string — Who the student lives with, which sets the living-cost model (default: "single-alone"; one of: "single-alone", "single-with-relatives", "married", "single-with-children"; examples: "single-alone")dependants integer — Number of dependent children (default: 0; examples: 0; min: 0; max: 20)study_year integer — Calendar year the study year starts in (default: 2026; examples: 2026; min: 2026; max: 2045)@type string (default: "EducanadaProgrammeCost")programme_id string requiredname string nullableinstitution string nullablecity string nullableprovince string nullableinstitution_url string nullablestudy_year integer nullableliving_status string nullable (one of: "single-alone", "single-with-relatives", "married", "single-with-children")dependants integer nullablecurrency string (default: "CAD")tuition number nullablecompulsory_fees number nullablebooks_supplies number nullableeducation_subtotal number nullableshelter number nullablegroceries number nullablemiscellaneous number nullablelocal_transport number nullableliving_subtotal number nullabletotal number nullablecalculated_at integer nullable422 — 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 — No programme has that id 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.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-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.