Biodiversity Heritage Library - API Version 3 Documentation

Search for publications (titles, items, and parts) that match the specified search term. You can search the catalog metadata only, or the full-text and the catalog metadata combined. The BHLType element identifies the type of each publication returned (Item or Part). Use the "pageSize" parameter to specify how many results are returned at once, up to a maximum of 200. Use the "page" parameter to return the next page of results.

https://www.biodiversitylibrary.org/api3?op=PublicationSearch

&searchterm=<the text for which to search>

&searchtype=<'C' for a catalog-only search; 'F' for a catalog+full-text search>

&page=<1 for the first page of results, 2 for the second, and so on>

&pageSize=<the maximum number of results to return per page (default = 100)>

&format=<"xml" for an XML response or "json" for JSON (OPTIONAL; "xml" is the default)>

&apikey=<API key value>

            
https://www.biodiversitylibrary.org/api3?op=PublicationSearch&searchterm=cocos+island+costa+rica+birds&searchtype=C&page=1&pageSize=10&format=xml&apikey=12345678-BBBB-DDDD-FFFF-123456789012

            

<?xml version="1.0" encoding="utf-8"?>
<Response
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Status>ok</Status>
  <ErrorMessage />
  <Result>
    <Publication>
      <BHLType>Part</BHLType>
      <FoundIn>Metadata</FoundIn>
      <Volume>2</Volume>
      <Authors>
        <Author>
          <Name>Gifford, Edward Winslow,</Name>
        </Author>
      </Authors>
      <PartUrl>https://www.biodiversitylibrary.org/part/69838</PartUrl>
      <PartID>69838</PartID>
      <Genre>Article</Genre>
      <Title>Field notes on the land birds of the Galapagos Islands, and of Cocos Island,Costa Rica</Title>
      <ContainerTitle>Proceedings of the California Academy of Sciences</ContainerTitle>
      <Series>4</Series>
      <Date>1919</Date>
      <PageRange>189--258</PageRange>
    </Publication>
    <Publication>
      <BHLType>Item</BHLType>
      <FoundIn>Metadata</FoundIn>
      <ItemID>167380</ItemID>
      <TitleID>89765</TitleID>
      <ExternalUrl>http://hdl.handle.net/2246/1677</ExternalUrl>
      <ItemUrl>https://www.biodiversitylibrary.org/item/167380</ItemUrl>
      <TitleUrl>https://www.biodiversitylibrary.org/bibliography/89765</TitleUrl>
      <Authors>
        <Author>
          <Name>Slud, Paul</Name>
        </Author>
      </Authors>
      <Genre>Book</Genre>
      <Title>The birds of Cocos Island (Costa Rica). Bulletin of the AMNH ; v. 134, article 4</Title>
    </Publication>
    <Publication>
      <BHLType>Part</BHLType>
      <FoundIn>Metadata</FoundIn>
      <Volume>6</Volume>
      <Authors>
        <Author>
          <Name>Carriker, Melbourne Armstrong,</Name>
        </Author>
      </Authors>
      <PartUrl>https://www.biodiversitylibrary.org/part/331038</PartUrl>
      <PartID>331038</PartID>
      <Genre>Article</Genre>
      <Title>An annotated list of the birds of Costa Rica including Cocos Island</Title>
      <Issue>2-3</Issue>
      <PageRange>314--915</PageRange>
    </Publication>
  </Result>
</Response>

            
https://www.biodiversitylibrary.org/api3?op=PublicationSearch&searchterm=cocos+island+costa+rica+birds&searchtype=C&page=1&pageSize=10&format=json&apikey=12345678-BBBB-DDDD-FFFF-123456789012

            
{
  "Status": "ok",
  "ErrorMessage": "",
  "Result": [
    {
      "BHLType": "Part",
      "FoundIn": "Metadata",
      "Volume": "2",
      "Authors": [
        {
          "Name": "Gifford, Edward Winslow,"
        }
      ],
      "PartUrl": "https://www.biodiversitylibrary.org/part/69838",
      "PartID": "69838",
      "Genre": "Article",
      "Title": "Field notes on the land birds of the Galapagos Islands, and of Cocos Island,Costa Rica",
      "ContainerTitle": "Proceedings of the California Academy of Sciences",
      "Series": "4",
      "Date": "1919",
      "PageRange": "189--258"
    },
    {
      "BHLType": "Item",
      "FoundIn": "Metadata",
      "ItemID": "167380",
      "TitleID": "89765",
      "ExternalUrl": "http://hdl.handle.net/2246/1677",
      "ItemUrl": "https://www.biodiversitylibrary.org/item/167380",
      "TitleUrl": "https://www.biodiversitylibrary.org/bibliography/89765",
      "Authors": [
        {
          "Name": "Slud, Paul"
        }
      ],
      "Genre": "Book",
      "Title": "The birds of Cocos Island (Costa Rica). Bulletin of the AMNH ; v. 134, article 4"
    },
    {
      "BHLType": "Part",
      "FoundIn": "Metadata",
      "Volume": "6",
      "Authors": [
        {
          "Name": "Carriker, Melbourne Armstrong,"
        }
      ],
      "PartUrl": "https://www.biodiversitylibrary.org/part/331038",
      "PartID": "331038",
      "Genre": "Article",
      "Title": "An annotated list of the birds of Costa Rica including Cocos Island",
      "Issue": "2-3",
      "PageRange": "314--915"
    }
  ]
}