Princeton University

Princeton University Banner API

The Banner API from Princeton University — 1 operation(s) for banner.

GitHub OpenAPI

Operations 1

GET /banner /banner #

Documentation

📖
APIReference
https://allsearch-api.princeton.edu/api-docs
📖
Documentation
https://github.com/pulibrary/allsearch_api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/princeton/refs/heads/main/authentication/princeton-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/princeton/refs/heads/main/openapi/princeton-banner-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/pulibrary/allsearch_api

Schemas & Data

📊
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

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/princeton/refs/heads/main/examples/princeton-allsearch-catalog-search-200.json
🔗
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/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/princeton-banner-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

princeton-banner-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Allsearch Banner API
  description: Backend API for allsearch.princeton.edu
  version: v1
servers:
- url: https://allsearch-api.princeton.edu
- url: https://allsearch-api-staging.princeton.edu
tags:
- name: Banner
paths:
  /banner:
    get:
      summary: /banner
      tags:
      - Banner
      operationId: displayBanner
      description: Displays the current settings for the banner
      responses:
        '200':
          description: successful
          content:
            application/json:
              example:
                text: ''
                display_banner: false
                alert_status: info
                dismissible: true
                autoclear: false