POST /api/petersons/online-schools/search
Price: 20 credits
Search Peterson's US online schools and programmes
List Peterson's US online schools and programmes by keywords and US state. The server filters only by state and country; one query returns at most 1000 of the matching total. Use a result id with the online-schools endpoint for the full profile.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)count integer required — Max number of results to return (min: 1; max: 1000)keywords string nullable — Keywords matched against listings; omit to list the whole catalogue. (examples: "nursing", "computer science"; minLength: 1)state string nullable — Two-letter US state code to restrict results to. (examples: "CA", "NY", "TX"; pattern: ^[A-Za-z]{2}$)country string nullable — Country code to restrict results to. (examples: "USA", "CAN"; pattern: ^[A-Za-z]{2,3}$)@type string (default: "PetersonsOnlineSchool")id string requiredurl string nullablealias string nullablename string requiredprogram_name string nullablerecord_kind string nullablecity string nullablestate string nullablestate_code string nullablecountry string nullablecountry_code string nullablezipcode string nullablelatitude number nullablelongitude number nullabledegree_levels array (default: [])student_types array (default: [])areas_of_study array (default: [])tuition number nullabletuition_range string nullablegpa_band string nullableimage string nullableupdated_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 — 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.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.