POST /api/opintopolku/institutions
Price: 5 credits
Get one Finnish educational institution, or one of its units, from Opintopolku (Studyinfo): type, teaching languages, home municipality, description, website, contact and admissions contact details with addresses, social media, student and campus counts, programme counts and every unit with its own contacts
Names, descriptions and contact details come per language (fi, sv, en). A unit id from `units` returns that unit with `is_unit` true and its parent institution. Pass the institution id to opintopolku/institutions/programs for everything it teaches.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)institution string required — Opintopolku institution or institution unit id, or its opintopolku.fi page URL (examples: "1.2.246.562.10.56753942459", "https://opintopolku.fi/konfo/fi/oppilaitos/1.2.246.562.10.38515028629"; minLength: 1)@type string (default: "OpintopolkuInstitution")id string requiredurl string nullablename object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableinstitution_type object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablestatus string nullableorganisation_types array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableis_unit boolean (default: false)parent_institution_id string nullableparent_institution_name object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableteaching_languages array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablehome_municipality object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullabledescription object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablecampus object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablewebsite object nullable@type string (default: "OpintopolkuLink")title object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableurl object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablevideo object nullable@type string (default: "OpintopolkuLink")title object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableurl object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablecontact object nullable@type string (default: "OpintopolkuContact")name object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableemail object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablephone object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablewebsite object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablevisiting_address object nullable@type string (default: "OpintopolkuAddress")street object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablepostal_code string nullablecity object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablevisiting_address_text object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablepostal_address object nullable@type string (default: "OpintopolkuAddress")street object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablepostal_code string nullablecity object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablepostal_address_text object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableadmissions_contact object nullable@type string (default: "OpintopolkuContact")name object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableemail object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablephone object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablewebsite object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablevisiting_address object nullable@type string (default: "OpintopolkuAddress")street object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablepostal_code string nullablecity object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablevisiting_address_text object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablepostal_address object nullable@type string (default: "OpintopolkuAddress")street object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablepostal_code string nullablecity object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablepostal_address_text object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablestudy_info array (default: [])@type string (default: "OpintopolkuSection")heading object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullabletext object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablesocial_links array (default: [])program_count integer nullabledegree_program_count integer nullablenon_degree_program_count integer nullablestudent_count integer nullablecampus_count integer nullablehigher_education_institution_count integer nullablefaculty_count integer nullableoffice_count integer nullableunit_count integer nullablehas_athlete_vocational_training boolean nullableunits array (default: [])@type string (default: "OpintopolkuInstitutionUnit")id string requiredurl string nullablename object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablestatus string nullableorganisation_types array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable (see schema OpintopolkuText)teaching_languages array (default: [])@type string (default: "OpintopolkuCode")code string requiredname object nullable (see schema OpintopolkuText)home_municipality object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullabledescription object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablecampus object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablewebsite object nullable@type string (default: "OpintopolkuLink")title object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableurl object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablecontact object nullable@type string (default: "OpintopolkuContact")name object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableemail object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablephone object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablewebsite object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablevisiting_address object nullable@type string (default: "OpintopolkuAddress")street object nullable (see schema OpintopolkuText)postal_code string nullablecity object nullable (see schema OpintopolkuText)visiting_address_text object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablepostal_address object nullable@type string (default: "OpintopolkuAddress")street object nullable (see schema OpintopolkuText)postal_code string nullablecity object nullable (see schema OpintopolkuText)postal_address_text object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableadmissions_contact object nullable@type string (default: "OpintopolkuContact")name object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullableemail object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablephone object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablewebsite object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablevisiting_address object nullable@type string (default: "OpintopolkuAddress")street object nullable (see schema OpintopolkuText)postal_code string nullablecity object nullable (see schema OpintopolkuText)visiting_address_text object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablepostal_address object nullable@type string (default: "OpintopolkuAddress")street object nullable (see schema OpintopolkuText)postal_code string nullablecity object nullable (see schema OpintopolkuText)postal_address_text object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablestudent_count integer nullablehas_athlete_vocational_training boolean nullableimage string nullablecover string nullablepublication_status string nullableorganisation object nullable@type string (default: "OpintopolkuOrganisation")id string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablemunicipality object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable (see schema OpintopolkuText)languages array (default: [])modified_at integer nullableimage string nullablecover string nullablepublication_status string nullableorganisation object nullable@type string (default: "OpintopolkuOrganisation")id string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablemunicipality object nullable@type string (default: "OpintopolkuCode")code string requiredname object nullable@type string (default: "OpintopolkuText")fi string nullablesv string nullableen string nullablelanguages array (default: [])modified_at integer nullableindexed_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 institution or institution unit 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.