POST /api/opintopolku/programs/providers
Price: 20 credits
List every implementation of one Opintopolku (Studyinfo) programme across Finnish institutions: the institution, municipalities, teaching languages and times, fees, scholarship, planned duration and whether the application is open. Filter by teaching language, region, municipality, teaching method and time, planned duration, application method, joint application, start term, prior education, selection method, an open or soon-opening application, funding and education type, fee type and amount, scholarship, institution and general upper secondary emphasis or special mission
One row per implementation and institution: an implementation offered by two institutions appears once under each, so `implementation_id` can repeat. Pass a row's `implementation_id` to opintopolku/implementations for its application options.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)teaching_times array nullable — Times the teaching takes place, any of (one of: "daytime", "evening", "weekend", "daytime_and_evening", "any_time"; examples: ["evening"])selection_methods array nullable — Student selection methods, any of (one of: "open_university_route", "certificate", "competition", "total_score", "exam", "other"; examples: ["exam"])application_methods array nullable — Ways of applying, any of (one of: "joint", "separate", "rolling_upper_secondary", "rolling_higher_education", "transfer", "supplementary"; examples: ["joint"])joint_applications array nullable — Joint application ids, any of (examples: ["1.2.246.562.29.00000000000000092075"])prior_education array nullable — Prior education an applicant holds, any of (one of: "basic_education", "no_basic_education", "general_upper_secondary", "matriculation_examination", "vocational_upper_secondary", "further_vocational", "specialist_vocational", "uas_bachelor", "university_bachelor", "uas_master", "university_master"; examples: ["matriculation_examination"])start_terms array nullable — Start terms, any of: a year and season, or individual (examples: ["2027-autumn"])is_application_open boolean nullable — Only offerings whose application period is open now (examples: true)is_jotpa_funded boolean nullable — Only offerings funded by the Service Centre for Continuous Learning (examples: true)is_labour_market_training boolean nullable — Only labour market training (examples: true)is_continuing_education boolean nullable — Only continuing education (examples: true)is_micro_credential boolean nullable — Only micro-credentials (examples: true)fee_type string nullable — Kind of fee charged (one of: "free", "fee", "tuition_fee", "tuition_fee_higher_education", "tuition_fee_upper_secondary"; examples: "tuition_fee")fee_min number nullable — Lowest fee in euros, with fee_type fee or a tuition_fee_ type (examples: 1000; min: 0)fee_max number nullable — Highest fee in euros, with fee_type fee or a tuition_fee_ type (examples: 12000; min: 0)has_scholarship boolean nullable — Only offerings with a scholarship, with a tuition fee_type (examples: true)teaching_languages array nullable — Languages of instruction, any of (one of: "finnish", "swedish", "finnish_and_swedish", "english", "sami", "other"; examples: ["english"])regions array nullable — Finnish regions where it is taught, any of (one of: "uusimaa", "southwest_finland", "satakunta", "kanta_hame", "pirkanmaa", "paijat_hame", "kymenlaakso", "south_karelia", "south_savo", "north_savo", "north_karelia", "central_finland", "south_ostrobothnia", "ostrobothnia", "central_ostrobothnia", "north_ostrobothnia", "kainuu", "lapland", "aland"; examples: ["uusimaa"])municipalities array nullable — Municipality codes where it is taught, any of (examples: ["091","049"])teaching_methods array nullable — Ways the teaching is delivered, any of (one of: "contact", "distance", "online", "blended", "independent", "apprenticeship"; examples: ["online"])is_application_opening_soon boolean nullable — Only offerings whose application period opens within 30 days (examples: true)duration_months_min integer nullable — Shortest planned duration in months (examples: 12; min: 0)duration_months_max integer nullable — Longest planned duration in months (examples: 24; min: 0)upper_secondary_emphases array nullable — General upper secondary emphasis codes (lukiopainotukset), any of (examples: ["0111"])upper_secondary_special_missions array nullable — General upper secondary special educational mission codes, any of (examples: ["0105"])institutions array nullable — Institution ids or page URLs, any of (examples: ["1.2.246.562.10.62505298505"])program string required — Opintopolku programme id or its opintopolku.fi page URL (examples: "1.2.246.562.13.00000000000000001022", "https://opintopolku.fi/konfo/en/koulutus/1.2.246.562.13.00000000000000000187"; minLength: 1)count integer required — Max number of implementations to return (min: 1; max: 2000)@type string (default: "OpintopolkuOffering")implementation_id string requiredimplementation_url string nullablename object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableprogram_id string nullableinstitution_id string nullableinstitution_name object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableinstitution_status string nullabledescription object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableprogram_type string nullabledegree_titles array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableteaching_language_codes array (default: [])teaching_times array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablemunicipalities array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablefee_types array (default: [])fee number nullabletuition_fee number nullablehas_scholarship boolean nullableduration_months integer nullableis_application_open boolean nullableis_special_needs_education boolean nullableis_special_needs_vocational boolean nullablehas_athlete_vocational_training boolean nullableimage string 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 is published under this 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.