libraries/{id}

Returns basic information about a given library, specified by library ID.

Resource URL

https://api.bibliocommons.com/v1/libraries/{id}

Request Parameters

Parameter Type Description Default Required?
id String The library ID.  Each library's BiblioCommons catalog will have a hostname of the form {id}.bibliocommons.com.  The {id} portion of the hostname is the library's ID. N/A Yes

Response Fields

Response Field Type Description Returned Link To *
id String The library ID. Always
name String The full name of the library. Always catalog_url
catalog_url String The URL for the library's BiblioCommons catalog. Always

Example Request

GET https://api.bibliocommons.com/v1/libraries/examplepl?api_key={key}

Response:

{
  "library": {
    "id": "examplepl",
    "name": "Example Public Library",
    "catalog_url": "http://examplepl.bibliocommons.com"
  }
}