{"@context": "https://schema.org", "@type": "WebAPI", "name": "NPR Listening Service API", "description": "Audio recommendations tailored to a user's preferences", "provider": {"@type": "Organization", "name": "npr.org"}, "documentation": "https://listening.api.npr.org/v2/swagger.json"}
Audio recommendations tailored to a user's preferences
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://listening.api.npr.org https://identity.api.npr.org https://authorization.api.npr.org https://sponsorship.api.npr.org https://station.api.npr.org
auth: o a u t h 2
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Audio recommendations tailored to a user's preferences
| method | path | what the vendor says it does |
|---|---|---|
GET | /v2/aggregation/{aggId}/recommendations | Get a set of recommendations for an aggregation independent of the user's listening history This endpoint prov |
GET | /v2/channels | Get the list of available channels These channels allow the user to specify a focus for the content returned i |
GET | /v2/history | Get recent ratings the logged-in user has submitted This endpoint provides the list of recently-rated audio re |
GET | /v2/organizations/{orgId}/categories/{category}/recommendations | Get a list of recommendations from a category of content from an organization This endpoint provides a list of |
GET | /v2/organizations/{orgId}/recommendations | Get a variety of details about an organization including various lists of recent audio items This endpoint pro |
GET | /v2/promo/recommendations | Retrieve the most recent promo audio heard by the logged-in user Gets the most recently played promo for which |
POST | /v2/ratings | Collect new ratings for media previously recommended to the logged-in user This endpoint is the main mechanism |
GET | /v2/recommendations | Get a list of media for the logged-in user from NPR's recommendation engine This endpoint returns a list of au |
GET | /v2/search/recommendations | Get a list of recent audio and aggregation items associated with search terms In the schema shown below, Searc |
specification origin: https://listening.api.npr.org/v2/swagger.json
The entry point to user-specific information
| method | path | what the vendor says it does |
|---|---|---|
POST | /v2/following | Update the following status of the logged-in user for a particular aggregation After a successful call, this r |
PUT | /v2/stations | Update the logged-in user's favorite station(s) Right now, only the primary station can be changed. Previously |
GET | /v2/user | Get the latest state information about the logged-in user After a successful login, the client should send a ` |
DELETE | /v2/user | Delete the user's account Use with caution as some steps are irreverisble. Initiates the user account deletion |
POST | /v2/user/inherit | Copy listening data from a temporary user account to the logged-in user's account This can and should only be |
specification origin: https://identity.api.npr.org/v2/swagger.json
The interface to our OAuth2 server
| method | path | what the vendor says it does |
|---|---|---|
POST | /v2/device | Initiate an OAuth2 login flow for limited input devices This flow should only be used by clients who cannot sh |
POST | /v2/token | Create a new OAuth2 access token Please be aware that the required parameters are contingent on the `grant_typ |
POST | /v2/token/revoke | Revoke an existing OAuth2 access token Our implementation follows the proposed IETF specification [RFC-7009](h |
specification origin: https://authorization.api.npr.org/v2/swagger.json
Sponsorship for non-NPR One client applications
| method | path | what the vendor says it does |
|---|---|---|
GET | /v2/ads | Request VAST sponsorship units **Not** for use by NPR One clients (for whom sponsorship is already integrated |
POST | /v2/ads | Record tracking data for VAST sponsorship units **Not** for use by NPR One clients (for whom sponsorship is al |
specification origin: https://sponsorship.api.npr.org/v2/swagger.json
Allows clients to look up NPR member station information
| method | path | what the vendor says it does |
|---|---|---|
GET | /v3/stations | List stations close to you or filter by search criteria This endpoint has two main use cases: - If no query p |
GET | /v3/stations/{stationId} | Retrieve metadata for the station with the given numeric ID This endpoint retrieves information about a given |
specification origin: https://station.api.npr.org/v3/swagger.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.