Library Locations

URLs and Supported Operations

Operation Resource URL HTTP METHOD
Lookup By OCLC Number http://www.worldcat.org/webservices/catalog/content/libraries/{OCLC_Number}?ip={IP_Address} GET
Lookup By ISBN
http://www.worldcat.org/webservices/catalog/content/libraries/isbn/{ISBN}?ip={IP_Address} GET
Lookup By ISSN http://www.worldcat.org/webservices/catalog/content/libraries/issn/{ISSN}?ip={IP_Address} GET
Lookup By Standard Number http://www.worldcat.org/webservices/catalog/content/libraries/sn/{Standard_Number}?ip={IP_Address} GET

Response Formats

The API response will either be a Holding structure, as shown in Response Details for just your designated library's OCLC symbol(s), or a "no holdings found" diagnostic.

Parameters

Parameter Description Required? Possible Values
ip IP address. API will try to resolve this to a geographic location and return nearby libraries
optional  
lat

Latitude

Used with the lon parameter to specify a set of coordinates to find libraries near

optional  
lon

Longitude

Used with the lat parameter to specify a set of coordinates to find libraries near

optional  
libtype Type of library to limit to
optional
  • 1 - academic library
  • 2 - public
  • 3 - government
  • 4 - other

location

Location to limit to. Can be a postal code, state, province, country name or country code

optional

 

 
maximiumLibraries

maximum number of libraries shown

top limit is 100 libraries per query

optional default is 10 libraries
format format of the response returned.
optional

json

callback

JSON-P callback. Only used with JSON-P response format

*Please do not embed your WSKey in client side javascripts*

optional  
frbrGrouping

whether or not to use FRBR grouping.

The default option includes the library locations associated with any similar edition of the item requested. This is sometimes referred to as a "FRBRized" holdings results.

To see holdings associated with only the single record requested set this parameter to "off".
See the note on frbrGrouping information for Library Location documentation.

optional

on, off

default is on

servicelevel Consult the Service Levels documentation to determine the differences in available indexes and displays between the two levels optional default, full
default is default
wskey Web Services Key required  

Resource Fields

XML Output

Field Description
/holding/institutionIdentifier/value Institution OCLC Symbol
/holding/institutionIdentifier/typeOrSource/pointer

Source for Institution Identifier

always set to http://worldcat.org/registry/institutions/

/holding/physicalLocation Name of Institution
/holding/physicalAddress/text Institution city, state postal code country
/library/opacUrl Url for item in Institution's local catalog

JSON Output

Field Description

title

Always given as zero

author Authori of item
date Date item published
ISBN ISBN(s) associated with item
OCLCnumber OCLC Number for item

totalLibCount

The number of symbols within the request that have holdings information returned.  This is the number of holding libraries in this particular response -- NOT the total number of holders of that item in all of WorldCat.

library/institutionName Name of Institution
library/streetAddress1 Street address of institution
library/streetAddress2 Street address part 2 of institution
library/city Institution city
library/state Institution state
library/country Institution country
library/postalCode Institution postal code
library/opacUrl Url for item in Institution's local catalog
library/oclcSymbol Institution OCLC Symbol
library/distance Always given as zero

URL Examples

Lookup libraries that holding OCLC Number 15550774 near the location associated with the IP address of the connecting client application:

GET http://www.worldcat.org/webservices/catalog/content/libraries/15550774

Lookup libraries that hold OCLC Number 15550774 near the zip code 94002:

GET http://www.worldcat.org/webservices/catalog/content/libraries/15550774?location=94002

Lookup public libraries in the state of Maine that hold OCLC Number 15550774:

GET http://www.worldcat.org/webservices/catalog/content/libraries/15550774?location=maine&libtype=2

Lookup libraries that hold OCLC Number 15550774 near the latitude/longitude coordinates 37.502508/-122.22702:

GET http://www.worldcat.org/webservices/catalog/content/libraries/15550774?lat=37.502508&lon=-122.22702

Lookup libraries that hold OCLC Number 15550774 in the Netherlands (by country code), starting at location 5 and including a maximum of 5 locations:

GET http://www.worldcat.org/webservices/catalog/content/libraries/15550774?location=nl&startLibrary=5&maximumLibraries=5

Lookup libraries that hold OCLC Number 15550774 near the location associated with the IP address 153.40.170.1:

GET http://www.worldcat.org/webservices/catalog/content/libraries/15550774?ip=153.40.170.1

Lookup libraries that hold OCLC Number 15550774 near the zip code 10029, but if that location value is not recognized, then near the location associated with the IP address 153.40.170.1:

GET http://www.worldcat.org/webservices/catalog/content/libraries/15550774?ip=153.40.170.1&location=10029

Notes

Known Issues

Queries for Merged OCLC Numbers result in no holdings

When an OCLC number has been merged under another record, the merged OCLC number is in the 019 field of that bibliographic record.  Using the merged OCLC number in a query correctly pulls the record which includes the 019 field for all SRU queries and Single Bibliographic record queries. However, for Library Catalog Resource requests, the merged OCLC number only works correctly if frbrGrouping is set to “on” or on by default.  When the frbrGrouping parameter is set to “off” the merged OCLC number request incorrectly results in indicating there are no holdings.

 

We are a worldwide library cooperative, owned, governed and sustained by members since 1967. Our public purpose is a statement of commitment to each other—that we will work together to improve access to the information held in libraries around the globe, and find ways to reduce costs for libraries through collaboration. Learn more »