POST /api/petersons/colleges
Price: 10 credits
Get a Peterson's US college profile by id or URL
Get one Peterson's US college profile by id or /college-search/ URL, with the overview, location and contact, tuition, student body breakdown and majors. Ids come from `id` in colleges search results.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)college string required — Peterson's college id or /college-search/ profile URL. (examples: "10002878", "https://www.petersons.com/college-search/southwest-florida-college-000_10002878.aspx"; minLength: 1)@type string (default: "PetersonsCollegeProfile")id string requiredurl string nullablealias string nullablename string requireddescription string nullablewebsite_url string nullableaddress object nullable@type string (default: "PetersonsAddress")street string nullablecity string nullablestate string nullablepostal_code string nullablecountry string nullablelatitude number nullablelongitude number nullablecontact object nullable@type string (default: "PetersonsContact")name string nullabletitle string nullableemail string nullablephone string nullablefax string nullableaddress string nullablefacts array (default: [])@type string (default: "PetersonsStat")label string requiredvalue string nullablerace_ethnicity array (default: [])@type string (default: "PetersonsStat")label string requiredvalue string nullablegender array (default: [])@type string (default: "PetersonsStat")label string requiredvalue string nullablemajors array (default: [])@type string (default: "PetersonsMajor")name string requireddegrees array (default: [])sections array (default: [])@type string (default: "PetersonsSection")id string requiredtitle string nullabletext 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 college 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.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.