/studocu/institutions

POST /api/studocu/institutions

Price: 10 credits

Get a Studocu institution by id or URL

How to use it

Get one Studocu institution (university or school) by numeric id or institution URL, with its location, website, student count and document counts per category. Use the id as `institution_id` when searching documents.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• institution string required — Studocu institution id or institution URL. (examples: "10023", "https://www.studocu.com/en-us/institution/chamberlain-university/10023"; minLength: 1)

Response

• @type string (default: "StudocuInstitution")
• id string required
• name string required
• short_name string nullable
• url string required
• website_url string nullable
• image string nullable
• about string nullable
• level string nullable
• country_id string nullable
• country_name string nullable
• region_code string nullable
• language_code string nullable
• language_name string nullable
• address string nullable
• latitude number nullable
• longitude number nullable
• student_count integer nullable
• document_count integer nullable
• lecture_notes_count integer nullable
• summary_count integer nullable
• mandatory_assignment_count integer nullable
• other_document_count integer nullable
• is_active boolean 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 — No institution with 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.

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.