Web Services

Title	Status	What is It	What it does	Query Protocols	Record Formats
Article Exchange API	Production	A write web service for cloud-based document delivery. Provides developer level access to the Article Exchange document-sharing site. Article Exchange provides a single, secure location where lending libraries can place requested documents and the borrowing library can retrieve articles or book chapters the library user requested via interlibrary loan. This url can be used to retrieve a document from the web service	Developers can upload and share documents of image-type files, such as .pdf .png .jpg .tiff and other image file formats. Upon successful upload, the response contains a unique password-protected URL that can be shared with the library user so s/he can retrieve the uploaded materials. Documents can be retrieved from the web service by using the short url and the password	XML, JSON	XML JSON
Interlibrary Loan Policies Directory	Production	A read only web service that allows a developer to send a query about an OCLC member library using their OCLC Symbol or Registry ID and in return receive ILL policies information about that institution.	Sends in an OCLC Symbol or Registry ID and the Policies Directory web service will return information about that symbol or ID including address, contact and ILL policies information. Additionally, developers can query for a specific piece of policy information such as hours, contacts, or fees.	OpenSearch	XML JSON
OpenURL Gateway	Production	An OpenURL-resolving Web service that redirects Web-based applications to provide their end-users direct access to full-text articles and other online resources available from libraries. The OpenURL Gateway pulls OpenURL data from the WorldCat Registry—a global directory for libraries, consortia, archives and museums. (www.worldcat.org/registry/institutions/)	Directs Web users to full text and other online resources at an appropriate library based on the user’s IP address.	OpenURL	None - Creates a URL redirect
QuestionPoint knowledge base API	Production	Developer-level access to QuestionPoint knowledge base Question and Answer (Q&A) pairs that QuestionPoint libraries saved for future re-use, for FAQ pages, for patron searches. The QuestionPoint global knowledge base is a collection of Q&A pairs contributed by nearly 500 libraries worldwide. Local knowledge bases are built and maintained by single libraries or regional library groups and usually contain information more specific to that group.	Provides search access to QuestionPoint Q&A pairs and returns questions that match the query Accesses a specific Q&A pair with metadataQuestion ID For example, the QuestionPoint knowledge base API could be used to retrieve a list of questions that have been asked on the topic of baseball. The API could then be used to return information about a specific question on that topic. For example: Which National League baseball teams have never won a World Series?	REST	HTML XML Text JSON
WMS Acquisitions API	Production	A read-write Web service for the Acquisitions module of OCLC WorldShare Management Services so library staff can create, update, delete and submit orders and get invoices for materials they’d like to acquire. Provides developer-level access to order, invoice, budget and funding data.	Lets you create purchase orders, retrieve invoice information and designate budget and funds information as needed for your institution. Facilitates the ability to access and edit existing orders or update an individual order status, and submit purchase orders to fulfillment vendors. Invoice functions provide vendor information with specific details such as quantity, price, shipping, etc. Through the Acquisitions API, you can combine your data with external fulfillment vendor data, such as that from Amazon, Alibris, YBP and others and save a lot of time, steps and screens in acquisitions workflows.	OpenSearch	XML JSON
WMS Circulation API	Production	A read-only Web service for the Circulation module of OCLC WorldShare Management Services, the WMS Circulation API lets library staff generate a pull list for materials.	Shows you which materials used need to be pulled for patron requests, holds, and digitization. This version represents only a small fraction of what’s coming with the Circulation service, including the ability to search for individual items.	OpenSearch	Atom as XML or JSON
WMS Collection Management API	Production	Developer-level access to WorldCat Local Holding Records (LHRs), with the ability to retrieve, create, update, and delete this information. LHRs let you add your local collection information, such as call numbers, location, notes and more.	This service allows libraries to access and change local copy information stored in WorldCat Local Holdings records, such as local call number and item location. Note: this functionality is ONLY available to libraries using OCLC WorldShare Management Services. The service helps the discovery view for end-users by providing them additional information about the material, and gives them more ways to search for specific, known items.	OpenSearch	Atom as XML or JSON
WMS NCIP Service	Production	A Web service to handle common library user-facing functions based on the industry standard NCIP functionality (NISO Circulation Interchange Protocol, also known as Z39.83). Part of the suite of APIs related to OCLC WorldShare Management Services.	Lets you check library materials in or out, place requests for materials or cancel existing requests.	NCIP	XML
WMS Vendor Information Center API	Production	Developer-level access to information about who your library works with—the vendors you rely on for materials, products, content and services.	This service lets you see and search for vendor information. Query options include location, status (active or inactive) and the ability recall by the first letter of the company name. Now you can see all the companies your library works with in a comprehensive list.	OpenSearch	XML JSON
WorldCat Basic API	Production	Developer-level access to WorldCat - for limited data.	Search WorldCat and receive results for items in libraries. (WorldCat Basic API is a scaled-down version of the WorldCat Search API.)	OpenSearch	Atom RSS
WorldCat Identities	Production	A service that provides personal, corporate and subject-based identities (writers, authors, characters, corporations, horses, ships, etc.) based on information in WorldCat.	Provides direct links to identity information based on LCCN or a personal name Provides access to identity information using OpenURL based on lastname and OCLC Number Provides search access to identity information	SRU, OpenURL	XML Identity Records SRU containing Identity Records Name Finder Search Response
WorldCat knowledge base API	Production	A read-only service for e-resource discovery and linking. Provides developer-level access to a library's information in the WorldCat knowledge base. The WorldCat knowledge base combines data about your library's econtent with access to it through linking features.	Tells you what electronic journals or ebooks your library has, and how to link to them. So you can provide access to the content your library subscribes to, in one click.	OpenURL, REST	XML JSON
Worldcat Registry	Production	Developer-level access to information in the Worldcat Registry: a free global directory for libraries, consortia, archives and museums. (http://www.worldcat.org/registry/institutions)	Search for basic information about institutions and consortia based on a variety of infromation in their WorldCat Registry Profile Retrieve detailed information about a single institution or consortium, based on Institution ID or OCLC Symbol Retrieve OpenURL resolver information based on Instution ID, OCLC Symbol, or IP address	REST, SRU	XML SRU Response with basic metadata for each institution Full Registry Record HTML
WorldCat Search API	Production	Developer-level Access to WorldCat - for bibliographic holdings and location data	Search WorldCat and retrieve bibliographic records for cataloged items, information about libraries that own the items and links to online catalog records when available.	SRU, Open Search	MARCXML (SRU), Dublin Core (SRU), Atom (OpenSearch), and RSS (OpenSearch). JSON options for lists of nearby libraries (holdings)
xISBN	Production	Submit an ISBN to this service, and it returns a list of related ISBNs and selected metadata.	Provides basic metadata about the object Provides list of other editions Converts between 10 and 13 digit ISBNs Fixes Checksum with ISBN Adds hyphens to ISBN	REST, OpenURL, unAPI	XML, JSON, CSV, TEXT, Python, PHP, Ruby, and HTML
xISSN	Production	Submit an ISSN to this service, and it returns a list of related ISSNs and selected metadata. ISSNs are related in two different ways: different editions of same serial (such as print and online editions) and historical relationships (ISSN changes that result from title changes, mergers, splits, etc.).	Provides all the forms related to a given ISSN Provides all the related editions related to a given ISSN Provides all the related ISSNs including other editions as well as preceding and succeeding ISSNs Provides basic metadata about a given ISSN Fixes checksum	REST, OpenURL, unAPI	XML, JSON, CSV, TEXT, Python, PHP, Ruby, and HTML
xOCLCNum	Production	Submit an OCLC Number, LCCN or OCLC work ID to this service and get back a list of associated OCLC numbers and brief metadata. OCLC Numbers are sorted by the number of times each items represented is held by a WorldCat Library: highest to lowest.	getVariants: list different variants of same OCLC number getEditions: list all relevant OCLC numbers and edition information getMetadata: get metadata	REST, OpenURL, unAPI	XML, JSON, CSV, TEXT, Python, PHP, Ruby, and HTML

Title

Status

What is It

What it does

Query Protocols

Record Formats

Production

A write web service for cloud-based document delivery. Provides developer level access to the Article Exchange document-sharing site. Article Exchange provides a single, secure location where lending libraries can place requested documents and the borrowing library can retrieve articles or book chapters the library user requested via interlibrary loan. This url can be used to retrieve a document from the web service

Developers can upload and share documents of image-type files, such as .pdf .png .jpg .tiff and other image file formats. Upon successful upload, the response contains a unique password-protected URL that can be shared with the library user so s/he can retrieve the uploaded materials. Documents can be retrieved from the web service by using the short url and the password

XML, JSON

XML

JSON

Interlibrary Loan Policies Directory

Production

A read only web service that allows a developer to send a query about an OCLC member library using their OCLC Symbol or Registry ID and in return receive ILL policies information about that institution.

Sends in an OCLC Symbol or Registry ID and the Policies Directory web service will return information about that symbol or ID including address, contact and ILL policies information. Additionally, developers can query for a specific piece of policy information such as hours, contacts, or fees.

OpenSearch

XML

JSON

OpenURL Gateway

Production

An OpenURL-resolving Web service that redirects Web-based applications to provide their end-users direct access to full-text articles and other online resources available from libraries. The OpenURL Gateway pulls OpenURL data from the WorldCat Registry—a global directory for libraries, consortia, archives and museums. (www.worldcat.org/registry/institutions/)

Directs Web users to full text and other online resources at an appropriate library based on the user’s IP address.

OpenURL

None - Creates a URL redirect

QuestionPoint knowledge base API

Production

Developer-level access to QuestionPoint knowledge base Question and Answer (Q&A) pairs that QuestionPoint libraries saved for future re-use, for FAQ pages, for patron searches. The QuestionPoint global knowledge base is a collection of Q&A pairs contributed by nearly 500 libraries worldwide. Local knowledge bases are built and maintained by single libraries or regional library groups and usually contain information more specific to that group.

Provides search access to QuestionPoint Q&A pairs and returns questions that match the query
Accesses a specific Q&A pair with metadataQuestion ID

For example, the QuestionPoint knowledge base API could be used to retrieve a list of questions that have been asked on the topic of baseball. The API could then be used to return information about a specific question on that topic.

For example: Which National League baseball teams have never won a World Series?

REST

HTML
XML
Text
JSON

WMS Acquisitions API

Production

A read-write Web service for the Acquisitions module of OCLC WorldShare Management Services so library staff can create, update, delete and submit orders and get invoices for materials they’d like to acquire. Provides developer-level access to order, invoice, budget and funding data.

Lets you create purchase orders, retrieve invoice information and designate budget and funds information as needed for your institution. Facilitates the ability to access and edit existing orders or update an individual order status, and submit purchase orders to fulfillment vendors. Invoice functions provide vendor information with specific details such as quantity, price, shipping, etc. Through the Acquisitions API, you can combine your data with external fulfillment vendor data, such as that from Amazon, Alibris, YBP and others and save a lot of time, steps and screens in acquisitions workflows.

OpenSearch

XML

JSON

WMS Circulation API

Production

A read-only Web service for the Circulation module of OCLC WorldShare Management Services, the WMS Circulation API lets library staff generate a pull list for materials.

Shows you which materials used need to be pulled for patron requests, holds, and digitization. This version represents only a small fraction of what’s coming with the Circulation service, including the ability to search for individual items.

OpenSearch

Atom as XML or JSON

WMS Collection Management API

Production

Developer-level access to WorldCat Local Holding Records (LHRs), with the ability to retrieve, create, update, and delete this information. LHRs let you add your local collection information, such as call numbers, location, notes and more.

This service allows libraries to access and change local copy information stored in WorldCat Local Holdings records, such as local call number and item location. Note: this functionality is ONLY available to libraries using OCLC WorldShare Management Services. The service helps the discovery view for end-users by providing them additional information about the material, and gives them more ways to search for specific, known items.

OpenSearch

Atom as XML or JSON

WMS NCIP Service

Production

A Web service to handle common library user-facing functions based on the industry standard NCIP functionality (NISO Circulation Interchange Protocol, also known as Z39.83). Part of the suite of APIs related to OCLC WorldShare Management Services.

Lets you check library materials in or out, place requests for materials or cancel existing requests.

NCIP

XML

WMS Vendor Information Center API

Production

Developer-level access to information about who your library works with—the vendors you rely on for materials, products, content and services.

This service lets you see and search for vendor information. Query options include location, status (active or inactive) and the ability recall by the first letter of the company name. Now you can see all the companies your library works with in a comprehensive list.

OpenSearch

XML

JSON

WorldCat Basic API

Production

Developer-level access to WorldCat - for limited data.

Search WorldCat and receive results for items in libraries. (WorldCat Basic API is a scaled-down version of the WorldCat Search API.)

OpenSearch

Atom
RSS

WorldCat Identities

Production

A service that provides personal, corporate and subject-based identities (writers, authors, characters, corporations, horses, ships, etc.) based on information in WorldCat.

Provides direct links to identity information based on LCCN or a
personal name
Provides access to identity information using OpenURL based on lastname and OCLC Number
Provides search access to identity information

SRU, OpenURL

XML
- Identity Records
- SRU containing Identity Records
- Name Finder Search Response

WorldCat knowledge base API

Production

A read-only service for e-resource discovery and linking. Provides developer-level access to a library's information in the WorldCat knowledge base. The WorldCat knowledge base combines data about your library's econtent with access to it through linking features.

Tells you what electronic journals or ebooks your library has, and how to link to them. So you can provide access to the content your library subscribes to, in one click.

OpenURL, REST

XML
JSON

Worldcat Registry

Production

Developer-level access to information in the Worldcat Registry: a free global directory for libraries, consortia, archives and museums. (http://www.worldcat.org/registry/institutions)

Search for basic information about institutions and consortia based on a variety of infromation in their WorldCat Registry Profile
Retrieve detailed information about a single institution or consortium, based on Institution ID or OCLC Symbol
Retrieve OpenURL resolver information based on Instution ID, OCLC Symbol, or IP address

REST, SRU

XML
- SRU Response with basic metadata for each institution
- Full Registry Record
HTML

WorldCat Search API

Production

Developer-level Access to WorldCat - for bibliographic holdings and location data

Search WorldCat and retrieve bibliographic records for cataloged items, information about libraries that own the items and links to online catalog records when available.

SRU, Open Search

MARCXML (SRU), Dublin Core (SRU), Atom (OpenSearch), and RSS (OpenSearch). JSON options for lists of nearby libraries (holdings)

xISBN

Production

Submit an ISBN to this service, and it returns a list of related ISBNs and selected metadata.

Provides basic metadata about the object
Provides list of other editions
Converts between 10 and 13 digit ISBNs
Fixes Checksum with ISBN
Adds hyphens to ISBN

REST, OpenURL, unAPI

XML, JSON, CSV, TEXT, Python, PHP, Ruby, and HTML

xISSN

Production

Submit an ISSN to this service, and it returns a list of related ISSNs and selected metadata. ISSNs are related in two different ways: different editions of same serial (such as print and online editions) and historical relationships (ISSN changes that result from title changes, mergers, splits, etc.).

Provides all the forms related to a given ISSN
Provides all the related editions related to a given ISSN
Provides all the related ISSNs including other editions as well as preceding and succeeding ISSNs
Provides basic metadata about a given ISSN
Fixes checksum

REST, OpenURL, unAPI

XML, JSON, CSV, TEXT, Python, PHP, Ruby, and HTML

xOCLCNum

Production

Submit an OCLC Number, LCCN or OCLC work ID to this service and get back a list of associated OCLC numbers and brief metadata. OCLC Numbers are sorted by the number of times each items represented is held by a WorldCat Library: highest to lowest.

getVariants: list different variants of same OCLC number
getEditions: list all relevant OCLC numbers and edition information
getMetadata: get metadata

REST, OpenURL, unAPI

XML, JSON, CSV, TEXT, Python, PHP, Ruby, and HTML

Follow the OCLC Developer Network:

The OCLC Developer Network supports the use of OCLC Web Services—a set of tools and APIs that expose data and services for WorldCat and our member libraries and partner institutions or companies. learn more »

Download the Developer Network Handbook 8.5x11 A9

Show your data source: add the WorldCat symbol