# Princeton University Library Allsearch API

**Canonical:** https://apis.io/apis/princeton/allsearch-api/  
**Provider:** Princeton University — https://apis.io/providers/princeton/  
**Base URL:** https://allsearch-api.princeton.edu  
**Documentation:** https://allsearch-api.princeton.edu/api-docs

Princeton University Library Allsearch API is one of 14 APIs that [Princeton University](https://apis.io/providers/princeton/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 2 JSON Schema definitions. Tagged areas include Library, Search, Discovery, Open Data, and JSON. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a GitHub repository, authentication docs, and 2 JSON Schemas.

The backend API for allsearch.princeton.edu, Princeton University Library's federated search. Fourteen operations fan one uniform envelope — number, records, more — across the catalog, articles, the Art Museum, digital collections, finding aids, journals, databases, LibGuides, LibAnswers, maps, library staff, the library website, best bets and a site banner. Public, anonymous, no key. This is the only OpenAPI document Princeton publishes: OpenAPI 3.1.1, served by the application itself at /api-docs/v1/swagger.yaml with a Swagger UI at /api-docs, generated from the application's own request specs and open-sourced as pulibrary/allsearch_api. All fourteen operations carry an operationId, summary, description and tags, and all thirty-two response media types carry an example. It declares no components, no securitySchemes and no root tag definitions, and info.contact is absent. Errors return a named problem code — {"error":{"problem":"QUERY_IS_EMPTY","message":…}}.

## Machine-readable artifacts (13)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/princeton/refs/heads/main/openapi/princeton-allsearch-api-openapi.yml
- **APIReference** — https://allsearch-api.princeton.edu/api-docs
- **Documentation** — https://github.com/pulibrary/allsearch_api
- **GitHubRepository** — https://github.com/pulibrary/allsearch_api
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/princeton/refs/heads/main/json-schema/princeton-allsearch-search-response.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/princeton/refs/heads/main/json-schema/princeton-allsearch-error.json
- **Examples** — https://raw.githubusercontent.com/api-evangelist/princeton/refs/heads/main/examples/princeton-allsearch-catalog-search-200.json
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/princeton/refs/heads/main/authentication/princeton-authentication.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/princeton/refs/heads/main/errors/princeton-errors.yml
- **SpectralRules** — https://raw.githubusercontent.com/api-evangelist/princeton/refs/heads/main/rules/princeton-openapi-spectral-rules.yml
- **Conformance** — https://raw.githubusercontent.com/api-evangelist/princeton/refs/heads/main/conformance/princeton-conformance.yml
- **Website** — https://allsearch.princeton.edu/
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/princeton/refs/heads/main/apis.yml

## Other Princeton University APIs (12)

- [Princeton University Art Museum API](https://apis.io/apis/princeton/art-museum-api/)
- [Princeton OIT API Gateway](https://apis.io/apis/princeton/oit-api-gateway/)
- [Princeton University Library Catalog (Orangelight)](https://apis.io/apis/princeton/catalog/)
- [PUL Bibliographic Data Web Service (Bibdata)](https://apis.io/apis/princeton/bibdata/)
- [Figgy Digital Repository — OAI-PMH and IIIF](https://apis.io/apis/princeton/figgy-oai/)
- [Princeton Data Commons — Discovery](https://apis.io/apis/princeton/data-commons/)
- [DataSpace Institutional Repository — OAI-PMH](https://apis.io/apis/princeton/dataspace-oai/)
- [Princeton University Library Finding Aids (PULFAlight)](https://apis.io/apis/princeton/finding-aids/)
- [Princeton University Library Maps and Geospatial Data (PUL Map)](https://apis.io/apis/princeton/maps/)
- [Digital PUL (DPUL)](https://apis.io/apis/princeton/digital-pul/)
- [Princeton Shibboleth Identity Provider — SAML 2.0 Metadata](https://apis.io/apis/princeton/shibboleth-idp/)
- [Ex Libris Alma / Primo VE — Princeton tenancy (01PRI_INST)](https://apis.io/apis/princeton/exlibris-tenancy/)

## Tags

Library, Search, Discovery, Open Data, JSON

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/princeton/allsearch-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/princeton/.