POST /api/bigfuture/colleges/search
Price: 20 credits
Search US colleges on BigFuture by state, major offered, control (public, private or for-profit), campus setting, award length and country. Returns each college's name, location, size, setting, net price, graduation rate, SAT/ACT percentile bands, AP policy, logos and social media
Find US colleges by state, major or area of study, control, setting or award length. Pass a returned `id` to bigfuture/colleges for the full record, or an `alias` to bigfuture/colleges/profile.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)state string nullable — US state or territory postal code the college is in (examples: "CA", "NY")major string nullable — Exact major name the college must offer, as in `majors[].name` of a bigfuture/colleges record (examples: "Biology/Biological Sciences, General")major_alias string nullable — Major `alias` from bigfuture/majors (`majors[].alias`); the college must offer that major (examples: "microbiology")area_of_study_alias string nullable — Area of study `alias` from bigfuture/majors; the college must offer a major of that area (examples: "biology")school_type string nullable — Public, private non-profit or for-profit control (one of: "public", "private", "for-profit"; examples: "public")school_setting string nullable — Surroundings of the main campus (one of: "urban", "suburban", "rural"; examples: "urban")school_years integer nullable — Length of the main award in years: 4 for a four-year college, 2 for two-year (examples: 4)country string nullable — ISO-2 country code of the college (examples: "US")count integer required — Max number of colleges to return (min: 1; max: 5000)@type string (default: "BigfutureCollegeCard")id string requiredname string requiredalias string nullableurl string nullablecity string nullablestate string nullablestate_name string nullablezip_code string nullablecountry string nullablecountry_name string nullableschool_setting string nullableschool_type string nullableschool_years integer nullableschool_size string nullableis_vocational boolean nullableaverage_net_price integer nullablegraduation_rate number nullablestandardized_test_policy string nullablecommon_application_url string nullablesat_math_25 integer nullablesat_math_75 integer nullablesat_ebrw_25 integer nullablesat_ebrw_75 integer nullablesat_composite_25 integer nullablesat_composite_75 integer nullableact_composite_25 integer nullableact_composite_75 integer nullableap_placement_awarded boolean nullableap_credit_awarded boolean nullableap_policy_url string nullableap_policy_description string nullableimage string nullablebanner_url string nullableredirect_aliases array (default: [])social_media object nullable@type string (default: "BigfutureSocialMedia")facebook array (default: [])twitter array (default: [])instagram array (default: [])youtube array (default: [])linkedin array (default: [])other array (default: [])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 — 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.