The New York Public Library Digital Collections API

For more than a century, The New York Public Library has amassed an extraordinary trove of rare and unique material covering the full spectrum of recorded knowledge. Now, for the first time, significant portions of the Library's digitized collections are available as machine-readable data: over 1 million objects and records for you to search, crawl and compute. Sign up and get hacking today!

Questions/feedback? Write to: repoapi@nypl.org

REST API version

The most recent version of the API is v1.

Important Links

Parameters To Pass To The API

Available Request Parameters


Parameter Value Default value Optional Description
.xml yes return response in xml format
.json yes return response in json format (default)
per_page integer, maximum 500 10 yes url parameter for number of rows to return per page
page integer, starts at 1 1 yes returns current row of results

Examples

  • http://api.repo.nypl.org/api/v1/items/2600a3f0-c5ec-012f-424e-58d385a7bc34?page=5
  • http://api.repo.nypl.org/api/v1/items/2600a3f0-c5ec-012f-424e-58d385a7bc34.xml?per_page=50&page=2
  • Check How To Query The API

API Request Limitations

The limit per authentication token while connecting from an application or curl request will be 10000 by default, this can be changed by admin

The limit per host will be 10000 by default if you are accessing API from browser

How To Access The API

There are two ways to access the API

About the Metadata Format

The MODS (Metadata Object Description Schema) format is a bibliographic schema developed by the Library of Congress. For more information about the schema visit the Library of Congress MODS web site.


itemLink URLs

Some itemLink URLs do not link to item records in the Digital Gallery. If you are harvesting these links, we highly suggest that you check them first to verify that they are valid links to resources before publishing them elsewhere. You will still be able to retrieve the metadata for these items via the Return MODS record for a capture UUID method.

Method 1: Return Captures for a UUID


Request URL: [base-url]/api/v1/items/[uuid]
Description: Return all capture UUIDs, imageIDs, itemLinks and titles (optional) for any UUID
Request Value: a UUID for any bibliographic level, including container (a/k/a parent), collection or item-level records. Capture UUIDs are not valid input values.
Return Values: uuid (capture), imageID, itemLink (see note about itemLink reliability) , title (capture, optional), page, perPage, totalPages, numResults

Optional Request Parameters


Parameter Values Default Value Optional Description
withTitles yes N/A yes returns title for each capture

Example A

Return all captures for a parent-level uuid, and display the uuid, imageID, itemLink and title (optional) for each capture

Request: api.repo.nypl.org/api/v1/items/5fa75050-c6c7-012f-e24b-58d385a7bc34.xml?withTitles=yes

Response:

    <nyplAPI>
      <request>
        <uuid>5fa75050-c6c7-012f-e24b-58d385a7bc34</uuid>
        <perPage>10</perPage>
        <page>1</page>
        <totalPages>13</totalPages>
      </request>
      <response>
        <headers>
          <status>success</status>
          <code>200</code>
          <message>ok</message>
        </headers>
        <numResults>125</numResults>
        <capture>
          <uuid>510d47e3-6c81-a3d9-e040-e00a18064a99</uuid>
          <imageID>1582733</imageID>
          <itemLink>http://digitalgallery.nypl.org/nypldigital/id?1582733</itemLink>
          <title>Mainardi, Uffizi, 1392. [Heads of two young men.]</title>
        </capture>
        <capture>
          <uuid>510d47e3-6c80-a3d9-e040-e00a18064a99</uuid>
          <imageID>1582732</imageID>
          <itemLink>http://digitalgallery.nypl.org/nypldigital/id?1582732</itemLink>
          <title>
            Domenico Ghirlandajo [sic], Munich, 885. [A bishop baptizing a person of ripe years.]
          </title>
        </capture>
        ... etc ...
      </response>
    </nyplAPI>
  

Example B

Return all captures for an item-level UUID, and display uuid, imageID and itemLink for each capture

Request: api.repo.nypl.org/api/v1/items/54da9490-c5aa-012f-62aa-58d385a7bc34.xml

Response:

<nyplAPI>
    <request>
        <uuid>54da9490-c5aa-012f-62aa-58d385a7bc34</uuid>
        <perPage>10</perPage>
        <page>1</page>
        <totalPages>1</totalPages>
    </request>
    <response>
        <headers>
          <status>success</status>
          <code>200</code>
          <message>ok</message>
        </headers>
        <numResults>4</numResults>
        <capture>
            <uuid>510d47e1-c5a8-a3d9-e040-e00a18064a99</uuid>
            <imageID>9811_002</imageID>
            <itemLink>http://digitalgallery.nypl.org/nypldigital/id?9811_002</itemLink>
        </capture>
        <capture>
            <uuid>510d47e1-c5aa-a3d9-e040-e00a18064a99</uuid>
            <imageID>9811_004</imageID>
            <itemLink>http://digitalgallery.nypl.org/nypldigital/id?9811_004</itemLink>
        </capture>
        <capture>
            <uuid>510d47e1-c5a7-a3d9-e040-e00a18064a99</uuid>
            <imageID>9811_001</imageID>
            <itemLink>http://digitalgallery.nypl.org/nypldigital/id?9811_001</itemLink>
        </capture>
        <capture>
            <uuid>510d47e1-c5a9-a3d9-e040-e00a18064a99</uuid>
            <imageID>9811_003</imageID>
            <itemLink>http://digitalgallery.nypl.org/nypldigital/id?9811_003</itemLink>
        </capture>
    </response>
</nyplAPI>
  

Method 2: Return UUID for local identifier


Request URL: [base-url]/api/v1/items/[local_identifier-field-name]/[local-identifier-value]
Description: Return uuid for a local identifier. Local_identifier field names can be found in the "type" attribute of the MODS <identifier> element (e.g. <identifier type="local_[identifier-field-name]">)
Request Value: a valid local identifier
Return Values: uuid, page, perPage, totalPages, numResults,

Examples of local identifier field names in MODS records:


    <identifier displayLabel="RLIN/OCLC" type="local_other">40687640</identifier>
    <identifier displayLabel="NYPL catalog ID (B-number)" type="local_bnumber">b13987862</identifier>
    <identifier displayLabel="Hades struc ID (legacy)" type="local_hades">1067457</identifier>
    <identifier displayLabel="Barcode" type="local_barcode">33333201354160</identifier>
 

Other searchable local_identifiers include: local_image_id

**Important Note** Capture-uuids are not returned in the response for this method. To find the associated capture uuid(s) for an item, call Method 1 (Return Captures for UUID) with the item-uuid value that is returned in this response.

Example

Return the item-uuid for a local_hades identifier.

Request: api.repo.nypl.org/api/v1/items/local_hades/1017240.xml

Response:

  <nyplAPI>
    <request>
        <identifier_type>local_hades</identifier_type>
        <identifier_val>1017240</identifier_val>
    </request>
    <response>
      <headers>
        <status>success</status>
        <code>200</code>
        <message>ok</message>
      </headers>
      <numResults>1</numResults>
      <uuid>ecaf7d80-c55f-012f-e3c7-58d385a7bc34</uuid>
    </response>
  </nyplAPI>
  

Method 3: Search in MODS field


Request URL: [base-url]/api/v1/items/search?q=[search-terms]&field=[mods-field]
Request Value: one or more search terms, a valid MODS field
Return Values:imageID, itemLink (see note about itemLink reliability), uuid (capture), title (capture), search_type, search_text, page, perPage, totalPages, numResults

Searchable MODS fields include these top level elements: identifier, typeOfResource, note. Searchable fields also include the following subelements: title, namePart, place, publisher, topic, geographic, temporal, genre, physicalLocation, and shelfLocator. For more information on MODS elements, see the list at the official MODS site

Example

Request: api.repo.nypl.org/api/v1/items/search.xml?q=flying&field=topic

Response:

  <nyplAPI>
  <request>
    <search_type>topic</search_type>
    <search_text>flying</search_text>
    <perPage>10</perPage>
    <page>1</page>
    <totalPages>11</totalPages>
  </request>
  <response>
  <headers>
   <status>success</status>
   <code>200</code>
   <message>OK</message>
 </headers>  
  <numResults>107</numResults>
    <result>
      <uuid>510d47de-7678-a3d9-e040-e00a18064a99</uuid>
      <imageID>1205682</imageID>
      <itemLink>http://digitalgallery.nypl.org/nypldigital/id?1205682</itemLink>
      <title>Charles Gardner.</title>
    </result>
    <result>
      <uuid>510d47de-7679-a3d9-e040-e00a18064a99</uuid>
      <imageID>1205683</imageID>
      <itemLink>http://digitalgallery.nypl.org/nypldigital/id?1205683</itemLink>
      <title>Charles Gardner.</title>
    </result>
    <result>
      <uuid>510d47de-767a-a3d9-e040-e00a18064a99</uuid>
      <imageID>1205684</imageID>
      <itemLink>http://digitalgallery.nypl.org/nypldigital/id?1205684</itemLink>
      <title>Squadron-Leader F.R.D. Swain.</title>
    </result>
    <result>
      <uuid>510d47de-767b-a3d9-e040-e00a18064a99</uuid>
      <imageID>1205685</imageID>
      <itemLink>http://digitalgallery.nypl.org/nypldigital/id?1205685</itemLink>
      <title>Squadron-Leader F.R.D. Swain.</title>
    </result>
    <result>
      <uuid>a41b5b78-8098-462b-e040-e00a18064443</uuid>
      <imageID>2038985</imageID>
      <itemLink>http://digitalgallery.nypl.org/nypldigital/id?2038985</itemLink>
      <title>
        A token of the future. Monsieur Santos-Dumont in midair.
      </title>
    </result>
    <result>
      <uuid>510d47e1-34c0-a3d9-e040-e00a18064a99</uuid>
      <imageID>822022</imageID>
      <itemLink>http://digitalgallery.nypl.org/nypldigital/id?822022</itemLink>
      <title>Kalongs, Einen Meeresarm Überfliegend.</title>
    </result>
    <result>
      <uuid>510d47e1-41e4-a3d9-e040-e00a18064a99</uuid>
      <imageID>822354</imageID>
      <itemLink>http://digitalgallery.nypl.org/nypldigital/id?822354</itemLink>
      <title>The Cobego.</title>
    </result>
    <result>
      <uuid>510d47e1-41ed-a3d9-e040-e00a18064a99</uuid>
      <imageID>822349</imageID>
      <itemLink>http://digitalgallery.nypl.org/nypldigital/id?822349</itemLink>
      <title>Colugo -- Galeopithecus Volitaus.</title>
    </result>
    <result>
      <uuid>510d47da-c152-a3d9-e040-e00a18064a99</uuid>
      <imageID>1133233</imageID>
      <itemLink>http://digitalgallery.nypl.org/nypldigital/id?1133233</itemLink>
      <title>Birds in Flight.</title>
    </result>
    <result>
      <uuid>510d47e1-34e3-a3d9-e040-e00a18064a99</uuid>
      <imageID>821995</imageID>
      <itemLink>http://digitalgallery.nypl.org/nypldigital/id?821995</itemLink>
      <title>Bats Flying, Hanging, And Grounded.]</title>
    </result>
  </response>
</nyplAPI>
  

Searching the Metadata

Search criteria described here are available in the current version, but may change based on new requirements.

The default Boolean operator for multiple search terms is "OR." However, items that contain all of the terms will appear higher in results than an item containing, for example, only one of the searched terms. Exact phrase matching can be accomplished by entering quotes around any phrase. To require that all items found must contain a term add a "+" before the term. To exclude a term from all of your results, add a "-" before the term.

Depending on how you are accessing the API, you may also need to use a url-encoded format for the "+" operator ("%2B") to get results

Examples
Find cats but not dogs
cats -dogs

All items found must contain cats and dogs
+cats +dogs

Find cats or dogs
cats dogs

Exact phrase match for term: New York City
"new york city"

Method 4: Search across all MODS fields


Request URL: [base-url]/api/v1/items/search?q=[search-terms]
Request Value: one or more search-terms
Return Values: imageID, itemLink (see note about itemLink reliability), uuid (capture), title (capture), search_text, page, perPage, totalPages, numResults

Example

Link: api.repo.nypl.org/api/v1/items/search.xml?q=birds

Response:

  <nyplAPI>
  <request>
    <search_text>birds</search_text>
    <perPage>10</perPage>
    <page>1</page>
    <totalPages>1199</totalPages>
  </request>
  <response>
   <headers>
    <status>success</status>
    <code>200</code>
    <message>OK</message>
   </headers>  
   <numResults>11985</numResults>
    <result>
      <uuid>510d47e0-d92c-a3d9-e040-e00a18064a99</uuid>
      <imageID>820568</imageID>
      <itemLink>http://digitalgallery.nypl.org/nypldigital/id?820568</itemLink>
      <title>Frigate, And Tropic-Birds.</title>
    </result>
    <result>
      <uuid>510d47e0-d999-a3d9-e040-e00a18064a99</uuid>
      <imageID>820808</imageID>
      <itemLink>http://digitalgallery.nypl.org/nypldigital/id?820808</itemLink>
      <title>Great Blue Heron.</title>
    </result>
    <result>
      <uuid>510d47e1-0404-a3d9-e040-e00a18064a99</uuid>
      <imageID>821616</imageID>
      <itemLink>http://digitalgallery.nypl.org/nypldigital/id?821616</itemLink>
      <title>Tailor-Bird -- Orthotómus Longicaudus.</title>
    </result>
    <result>
      <uuid>510d47e0-d4fd-a3d9-e040-e00a18064a99</uuid>
      <imageID>820261</imageID>
      <itemLink>http://digitalgallery.nypl.org/nypldigital/id?820261</itemLink>
      <title>Wading Birds.</title>
    </result>
    ... etc ...
    <result>
      <uuid>510d47e1-3f72-a3d9-e040-e00a18064a99</uuid>
      <imageID>820129</imageID>
      <itemLink>http://digitalgallery.nypl.org/nypldigital/id?820129</itemLink>
      <title>Various Kinds Of Birds.</title>
    </result>
  </response>
</nyplAPI>
  

Searching the Metadata

Search criteria described here are available in the current version, but may change based on new requirements.

The default Boolean operator for multiple search terms is "OR." However, items that contain all of the terms will appear higher in results than an item containing, for example, only one of the searched terms. Exact phrase matching can be accomplished by entering quotes around any phrase. To require that all items found must contain a term add a "+" before the term. To exclude a term from all of your results, add a "-" before the term.

Depending on how you are accessing the API, you may also need to use a url-encoded format for the "+" operator ("%2B") to get results

Examples
Find cats but not dogs
cats -dogs

All items found must contain cats and dogs
+cats +dogs

Find cats or dogs
cats dogs

Exact phrase match for term: New York City
"new york city"

Method 5: Return MODS record for a capture UUID


Request Value: a valid capture-uuid
Return Values: A MODS bibliographic record

Example

Link: http://api.repo.nypl.org/api/v1/items/mods/510d47e2-8e15-a3d9-e040-e00a18064a99.xml

Response:

  <nyplAPI>
  <request>
    <uuid>510d47e2-8e15-a3d9-e040-e00a18064a99</uuid>
  </request>
  <response>
    <headers>
      <status>success</status>
      <code>200</code>
      <message>OK</message>
    </headers>  
    <mods xmlns="http://www.loc.gov/mods/v3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="3.4"xsi:schemaLocation="http://www.loc.gov/mods/v3 http://www.loc.gov/standards/mods/v3/mods-3-4.xsd">
      <titleInfo lang="eng" supplied="no" usage="primary">
        <title>Mid-Manhattan Picture Collection</title>
      </titleInfo>
      <titleInfo supplied="no" usage="primary">
        <title>New York City -- Skyline</title>
      </titleInfo>
      <titleInfo lang="eng" supplied="no" usage="primary">
        <title>High buildings in New York at night.</title>
      </titleInfo>
      <typeOfResource>still image</typeOfResource>
      <identifier displayLabel="Dynix" type="local_other">1617433</identifier>
      <identifier displayLabel="NYPL catalog ID (B-number)" type="local_bnumber">b17540797</identifier>
      <identifier displayLabel="Hades struc ID (legacy)" type="local_hades">1017240</identifier>
      <identifier displayLabel="Barcode" type="local_barcode">33333201354160</identifier>
      <location>
        <physicalLocation authority="marcorg" type="repository">nn</physicalLocation>
        <physicalLocation type="division">Art and Picture Collection</physicalLocation>
      </location>
      <location>
        <shelfLocator>PC NEW YC-Skyl</shelfLocator>
      </location>
      <location>
        <physicalLocation type="division">Art and Picture Collection</physicalLocation>
      </location>
      <name authority="" type="corporate" valueURI="">
        <namePart>Franz Huld</namePart>
        <affiliation/>
        <role>
          <roleTerm authority="marcrelator" type="code" valueURI="http://id.loc.gov/vocabulary/relators/pbl">pbl</roleTerm>
          <roleTerm authority="marcrelator" type="text" valueURI="http://id.loc.gov/vocabulary/relators/pbl">Publisher</roleTerm>
        </role>
      </name>
      <genre>Pochoir prints</genre>
      <originInfo>
        <place>
          <placeTerm>New York</placeTerm>
        </place>
      </originInfo>
      <subject>
        <topic authority="lctgm">Sunrises & sunsets -- New York (State) -- New York</topic>
      </subject>
      <subject>
        <topic authority="lctgm">
          Skyscrapers -- New York (State) -- New York -- 1900-1909
        </topic>
      </subject>
      <subject>
        <geographic authority="naf">New York (N.Y.) -- 1900-1909</geographic>
        <cartographics/>
      </subject>
      <relatedItem type="host">
        <titleInfo>
          <title>New York City -- skyline</title>
        </titleInfo>
        <identifier type="uuid">e6b85000-c55f-012f-27fc-58d385a7bc34</identifier>
        <relatedItem type="host">
          <titleInfo>
            <title>Mid-Manhattan Picture Collection</title>
          </titleInfo>
          <identifier type="uuid">79d4a650-c52e-012f-67ad-58d385a7bc34</identifier>
        </relatedItem>
      </relatedItem>
    </mods>
  </response>
</nyplAPI>
  


JSON Example


Link: http://api.repo.nypl.org/api/v1/items/mods/510d47da-2078-a3d9-e040-e00a18064a99

Response:


{
    "nyplAPI": {
        "request": {
            "uuid": {
                "$": "510d47da-2078-a3d9-e040-e00a18064a99"
            }
        },
        "response": {
            "headers": {
                "status": {
                    "$": "success"
                },
                "code": {
                    "$": "200"
                },
                "message": {
                    "$": "OK"
                }
            },
            "mods": {
                "version": "3.4",
                "schemaLocation": "http://www.loc.gov/mods/v3 http://www.loc.gov/standards/mods/v3/mods-3-4.xsd",
                "titleInfo": [
                    {
                        "lang": "eng",
                        "supplied": "no",
                        "usage": "primary",
                        "title": {
                            "$": "Emmet Collection of Manuscripts Etc. Relating to American History."
                        }
                    },
                    {
                        "supplied": "no",
                        "usage": "primary",
                        "nonSort": {
                            "$": "The"
                        },
                        "title": {
                            "$": "pictorial field-book of the Revolution."
                        }
                    },
                    {
                        "supplied": "no",
                        "usage": "primary",
                        "title": {
                            "$": "Volume 2 (Chapters 12-13)."
                        }
                    },
                    {
                        "supplied": "no",
                        "usage": "primary",
                        "title": {
                            "$": "Bank of Pennsylvania, South Second Street, Philadelphia."
                        }
                    }
                ],
                "name": [
                    {
                        "authority": "naf",
                        "type": "personal",
                        "usage": "primary",
                        "valueURI": "",
                        "namePart": {
                            "$": "Emmet, Thomas Addis (1828-1919)"
                        },
                        "affiliation": {},
                        "role": {
                            "roleTerm": [
                                {
                                    "authority": "marcrelator",
                                    "type": "code",
                                    "valueURI": "http://id.loc.gov/vocabulary/relators/col",
                                    "$": "col"
                                },
                                {
                                    "authority": "marcrelator",
                                    "type": "text",
                                    "valueURI": "http://id.loc.gov/vocabulary/relators/col",
                                    "$": "Collector"
                                }
                            ]
                        }
                    },
                    {
                        "authority": "naf",
                        "type": "personal",
                        "valueURI": "",
                        "namePart": {
                            "$": "Lossing, Benson John (1813-1891)"
                        },
                        "affiliation": {},
                        "role": {
                            "roleTerm": [
                                {
                                    "authority": "marcrelator",
                                    "type": "code",
                                    "valueURI": "http://id.loc.gov/vocabulary/relators/aut",
                                    "$": "aut"
                                },
                                {
                                    "authority": "marcrelator",
                                    "type": "text",
                                    "valueURI": "http://id.loc.gov/vocabulary/relators/aut",
                                    "$": "Author"
                                }
                            ]
                        }
                    },
                    {
                        "authority": "naf",
                        "type": "corporate",
                        "usage": "primary",
                        "valueURI": "",
                        "namePart": {
                            "$": "W. Birch & Son"
                        },
                        "affiliation": {},
                        "role": {
                            "roleTerm": [
                                {
                                    "authority": "marcrelator",
                                    "type": "code",
                                    "valueURI": "http://id.loc.gov/vocabulary/relators/etr",
                                    "$": "etr"
                                },
                                {
                                    "authority": "marcrelator",
                                    "type": "text",
                                    "valueURI": "http://id.loc.gov/vocabulary/relators/etr",
                                    "$": "Etcher"
                                }
                            ]
                        }
                    },
                    {
                        "authority": "naf",
                        "type": "corporate",
                        "valueURI": "",
                        "namePart": {
                            "$": "W. Birch & Son"
                        },
                        "affiliation": {},
                        "role": {
                            "roleTerm": [
                                {
                                    "authority": "marcrelator",
                                    "type": "code",
                                    "valueURI": "http://id.loc.gov/vocabulary/relators/art",
                                    "$": "art"
                                },
                                {
                                    "authority": "marcrelator",
                                    "type": "text",
                                    "valueURI": "http://id.loc.gov/vocabulary/relators/art",
                                    "$": "Artist"
                                }
                            ]
                        }
                    }
                ],
                "typeOfResource": {
                    "$": "still image"
                },
                "note": [
                    {
                        "type": "content",
                        "$": "Relief shown by hachures."
                    },
                    {
                        "type": "content",
                        "$": "Volume numbers given here refer to the original volume numbers of the publication, not of Lossing's publication."
                    },
                    {
                        "type": "content",
                        "$": "Printmakers include William Birch, H.B. Hall, Charles Hullmandel and H. Meyer.  Draughtsman is David McNeely Stauffer."
                    },
                    {
                        "type": "content",
                        "$": "Title from title page of extra-illustrated volume."
                    },
                    {
                        "type": "citation/reference",
                        "$": "EM5824"
                    }
                ],
                "identifier": [
                    {
                        "displayLabel": "CATNYP ID (legacy)",
                        "type": "local_catnyp",
                        "$": "b3837016"
                    },
                    {
                        "displayLabel": "RLIN/OCLC",
                        "type": "local_other",
                        "$": "NYPG95-F255"
                    },
                    {
                        "displayLabel": "NYPL catalog ID (B-number)",
                        "type": "local_bnumber",
                        "$": "b12349150"
                    },
                    {
                        "displayLabel": "Hades struc ID (legacy)",
                        "type": "local_hades",
                        "$": "164879"
                    }
                ],
                "location": [
                    {
                        "physicalLocation": [
                            {
                                "authority": "marcorg",
                                "type": "repository",
                                "$": "nn"
                            },
                            {
                                "type": "division",
                                "$": "Wallach Division: Print Collection"
                            }
                        ]
                    },
                    {
                        "shelfLocator": {
                            "$": "MEZP"
                        }
                    },
                    {
                        "physicalLocation": {
                            "type": "division",
                            "$": "Wallach Division: Print Collection"
                        }
                    }
                ],
                "genre": {
                    "$": "Etchings -- Hand-colored"
                },
                "originInfo": {
                    "dateCreated": {
                        "$": "1799"
                    },
                    "publisher": {
                        "$": "[W. Birch & Son]"
                    }
                },
                "subject": [
                    {
                        "topic": {
                            "authority": "lctgm",
                            "$": "Banks -- Pennsylvania -- Philadelphia"
                        }
                    },
                    {
                        "name": {
                            "authority": "naf",
                            "type": "corporate",
                            "namePart": {
                                "$": "Bank of Pennsylvania"
                            }
                        }
                    }
                ],
                "relatedItem": {
                    "type": "host",
                    "titleInfo": {
                        "title": {
                            "$": "Volume 2 (Chapters 12-13)."
                        }
                    },
                    "identifier": {
                        "type": "uuid",
                        "$": "e086e9c0-c608-012f-4f7b-58d385a7bc34"
                    },
                    "relatedItem": {
                        "type": "host",
                        "titleInfo": {
                            "title": {
                                "$": "The pictorial field-book of the Revolution."
                            }
                        },
                        "identifier": {
                            "type": "uuid",
                            "$": "0a1f1fe0-c608-012f-7a1a-58d385a7bc34"
                        },
                        "relatedItem": {
                            "type": "host",
                            "titleInfo": {
                                "title": {
                                    "$": "Emmet Collection of Manuscripts Etc. Relating to American History."
                                }
                            },
                            "identifier": {
                                "type": "uuid",
                                "$": "491273d0-c605-012f-4af6-58d385a7bc34"
                            }
                        }
                    }
                }
            }
        }
    }
}

  

Errors & Response Codes

No Results for a Valid Search



Invalid Path

    <nyplAPI>
      <request>
        <path>/documentation.xml</path>
      </request>
      <response>
        <headers>
          <status>error</status>
          <code>400</code>
          <message>The path that you entered is invalid. Please review our documentation and enter a valid path.</message>
        </headers>  
      </response>
    </nyplAPI>
    

Service unavailable



Rate Limit Exceeded

    <nyplAPI>
      <request>
        [IP-Address]
      </request>
      <response>
        <headers>
          <status>error</status>
          <code>403</code>
          <message>Sorry, Rate Limit Exceeded, please try again.</message>
        </headers>  
      </response>
    </nyplAPI>