Biodiversity Heritage Library
API v3 Documentation
Overview
Methods
Data Elements
Release Notes

GetNameMetadata
Get basic title, item, and page metadata for each page on which the canonical form of the specified name appears.  For example, assume the name "Poa annua Linnaeus", or an identifier for that name, is specified.  The API method will return title/item/page metadata for all pages on which one of the following names appears:  "Poa annua", "Poa annua L.", "Poa annua Linnaeus", "Poa annua L. (1753)".  Those names all share a canonical form of "Poa annua".
SYNTAX
https://www.biodiversitylibrary.org/api3?op=GetNameMetadata
&name=<a complete scientific name (not used if id/idtype are specified)>
&id=<identifier of a scientific name (not used if name is specified)>
&idtype=<namebank, eol, gni, ion, col, gbif, itis, ipni, or worms (not used if name is specified)>
&format=<"xml" for an XML response or "json" for JSON (OPTIONAL; "xml" is the default)>
&apikey=<API key value>
EXAMPLE REQUESTS (XML)
            
https://www.biodiversitylibrary.org/api3?op=GetNameMetadata&name=bulbophyllum+stella&format=xml&apikey=12345678-BBBB-DDDD-FFFF-123456789012

https://www.biodiversitylibrary.org/api3?op=GetNameMetadata&id=5775264&idtype=namebank&format=xml&apikey=12345678-BBBB-DDDD-FFFF-123456789012
            
        
EXAMPLE RESPONSE (XML)
            

<?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>
    <Name>
      <Identifiers>
        <Identifier>
          <IdentifierName>GNI</IdentifierName>
          <IdentifierValue>dedb8e15-3929-581e-9b98-bde6b02d2814</IdentifierValue>
        </Identifier>
        <Identifier>
          <IdentifierName>NameBank</IdentifierName>
          <IdentifierValue>5775264</IdentifierValue>
        </Identifier>
      </Identifiers>
      <NameConfirmed>Bulbophyllum stella</NameConfirmed>
      <NameCanonical>Bulbophyllum stella</NameCanonical>
      <CreationDate>2008/06/20 04:56:27</CreationDate>
      <Titles>
        <Title>
          <TitleID>51678</TitleID>
          <ShortTitle>Journal of the Asiatic Society of Bengal</ShortTitle>
          <CallNumber>Q73.C35 J68</CallNumber>
          <PublisherPlace>Calcutta</PublisherPlace>
          <PublisherName>Bishop's College Press</PublisherName>
          <PublicationDate>1832-1936</PublicationDate>
          <TitleUrl>https://www.biodiversitylibrary.org/title/51678</TitleUrl>
          <Items>
            <Item>
              <ItemID>110228</ItemID>
              <Source>Internet Archive</Source>
              <SourceIdentifier>journalofasiatic66unse</SourceIdentifier>
              <Volume>v.66:pt.2 (1897)</Volume>
              <HoldingInstitution>California Academy of Sciences</HoldingInstitution>
              <ItemUrl>https://www.biodiversitylibrary.org/item/110228</ItemUrl>
              <Pages>
                <Page>
                  <PageID>35622177</PageID>
                  <ItemID>110228</ItemID>
                  <Volume>66</Volume>
                  <Year>1897</Year>
                  <TextSource>OCR</TextSource>
                  <PageUrl>https://www.biodiversitylibrary.org/page/35622177</PageUrl>
                  <ThumbnailUrl>https://www.biodiversitylibrary.org/pagethumb/35622177</ThumbnailUrl>
                  <FullSizeImageUrl>https://www.biodiversitylibrary.org/pageimage/35622177</FullSizeImageUrl>
                  <OcrUrl>https://www.biodiversitylibrary.org/pagetext/35622177</OcrUrl>
                  <PageTypes>
                    <PageType>
                      <PageTypeName>Text</PageTypeName>
                    </PageType>
                  </PageTypes>
                  <PageNumbers>
                    <PageNumber />
                  </PageNumbers>
                </Page>
                <Page>
                  <PageID>35622324</PageID>
                  <ItemID>110228</ItemID>
                  <TextSource>OCR</TextSource>
                  <PageUrl>https://www.biodiversitylibrary.org/page/35622324</PageUrl>
                  <ThumbnailUrl>https://www.biodiversitylibrary.org/pagethumb/35622324</ThumbnailUrl>
                  <FullSizeImageUrl>https://www.biodiversitylibrary.org/pageimage/35622324</FullSizeImageUrl>
                  <OcrUrl>https://www.biodiversitylibrary.org/pagetext/35622324</OcrUrl>
                  <PageTypes>
                    <PageType>
                      <PageTypeName>Text</PageTypeName>
                    </PageType>
                  </PageTypes>
                  <PageNumbers>
                    <PageNumber />
                  </PageNumbers>
                </Page>
              </Pages>
            </Item>
          </Items>
        </Title>
        <Title>
          <TitleID>84482</TitleID>
          <ShortTitle>Repertorium specierum novarum regni vegetabilis</ShortTitle>
          <CallNumber>QK1 .R425Z</CallNumber>
          <PublisherPlace>Dahlem bei Berlin</PublisherPlace>
          <PublisherName>Verlag des Repertoriums</PublisherName>
          <PublicationDate>1911-1941</PublicationDate>
          <TitleUrl>https://www.biodiversitylibrary.org/title/84482</TitleUrl>
          <Items>
            <Item>
              <ItemID>28953</ItemID>
              <Source>Internet Archive</Source>
              <SourceIdentifier>repertoriumspeci01fedd</SourceIdentifier>
              <Volume>v.1 (1914)</Volume>
              <HoldingInstitution>New York Botanical Garden, LuEsther T. Mertz Library</HoldingInstitution>
              <ItemUrl>https://www.biodiversitylibrary.org/item/28953</ItemUrl>
              <Pages>
                <Page>
                  <PageID>5904859</PageID>
                  <ItemID>28953</ItemID>
                  <TextSource>OCR</TextSource>
                  <PageUrl>https://www.biodiversitylibrary.org/page/5904859</PageUrl>
                  <ThumbnailUrl>https://www.biodiversitylibrary.org/pagethumb/5904859</ThumbnailUrl>
                  <FullSizeImageUrl>https://www.biodiversitylibrary.org/pageimage/5904859</FullSizeImageUrl>
                  <OcrUrl>https://www.biodiversitylibrary.org/pagetext/5904859</OcrUrl>
                  <PageTypes>
                    <PageType>
                      <PageTypeName>Text</PageTypeName>
                    </PageType>
                  </PageTypes>
                  <PageNumbers>
                    <PageNumber>
                      <Prefix>Page</Prefix>
                      <Number>754</Number>
                    </PageNumber>
                  </PageNumbers>
                </Page>
              </Pages>
            </Item>
          </Items>
        </Title>
      </Titles>
    </Name>
  </Result>
</Response>

            
        
EXAMPLE REQUESTS (JSON)
            
https://www.biodiversitylibrary.org/api3?op=GetNameMetadata&name=bulbophyllum+stella&format=json&apikey=12345678-BBBB-DDDD-FFFF-123456789012

https://www.biodiversitylibrary.org/api3?op=GetNameMetadata&id=5775264&idtype=namebank&format=json&apikey=12345678-BBBB-DDDD-FFFF-123456789012
            
        
EXAMPLE RESPONSE (JSON)
            
{
  "Status": "ok",
  "ErrorMessage": "",
  "Result": [
    {
      "Identifiers": [
        {
          "IdentifierName": "GNI",
          "IdentifierValue": "dedb8e15-3929-581e-9b98-bde6b02d2814"
        },
        {
          "IdentifierName": "NameBank",
          "IdentifierValue": "5775264"
        }
      ],
      "NameConfirmed": "Bulbophyllum stella",
      "NameCanonical": "Bulbophyllum stella",
      "CreationDate": "2008/06/20 04:56:27",
      "Titles": [
        {
          "TitleID": 51678,
          "ShortTitle": "Journal of the Asiatic Society of Bengal",
          "CallNumber": "Q73.C35 J68",
          "PublisherPlace": "Calcutta",
          "PublisherName": "Bishop's College Press",
          "PublicationDate": "1832-1936",
          "TitleUrl": "https://www.biodiversitylibrary.org/title/51678",
          "Items": [
            {
              "ItemID": 110228,
              "Source": "Internet Archive",
              "SourceIdentifier": "journalofasiatic66unse",
              "Volume": "v.66:pt.2 (1897)",
              "HoldingInstitution": "California Academy of Sciences",
              "ItemUrl": "https://www.biodiversitylibrary.org/item/110228",
              "Pages": [
                {
                  "PageID": 35622324,
                  "ItemID": "110228",
                  "TextSource": "OCR",
                  "PageUrl": "https://www.biodiversitylibrary.org/page/35622324",
                  "ThumbnailUrl": "https://www.biodiversitylibrary.org/pagethumb/35622324",
                  "FullSizeImageUrl": "https://www.biodiversitylibrary.org/pageimage/35622324",
                  "OcrUrl": "https://www.biodiversitylibrary.org/pagetext/35622324",
                  "PageTypes": [
                    {
                      "PageTypeName": "Text"
                    }
                  ],
                  "PageNumbers": [
                    {}
                  ]
                },
                {
                  "PageID": 35622177,
                  "ItemID": "110228",
                  "Volume": "66",
                  "Year": "1897",
                  "TextSource": "OCR",
                  "PageUrl": "https://www.biodiversitylibrary.org/page/35622177",
                  "ThumbnailUrl": "https://www.biodiversitylibrary.org/pagethumb/35622177",
                  "FullSizeImageUrl": "https://www.biodiversitylibrary.org/pageimage/35622177",
                  "OcrUrl": "https://www.biodiversitylibrary.org/pagetext/35622177",
                  "PageTypes": [
                    {
                      "PageTypeName": "Text"
                    }
                  ],
                  "PageNumbers": [
                    {}
                  ]
                }
              ]
            }
          ]
        },
        {
          "TitleID": 84482,
          "ShortTitle": "Repertorium specierum novarum regni vegetabilis",
          "CallNumber": "QK1 .R425Z",
          "PublisherPlace": "Dahlem bei Berlin",
          "PublisherName": "Verlag des Repertoriums",
          "PublicationDate": "1911-1941",
          "TitleUrl": "https://www.biodiversitylibrary.org/title/84482",
          "Items": [
            {
              "ItemID": 28953,
              "Source": "Internet Archive",
              "SourceIdentifier": "repertoriumspeci01fedd",
              "Volume": "v.1 (1914)",
              "HoldingInstitution": "New York Botanical Garden, LuEsther T. Mertz Library",
              "ItemUrl": "https://www.biodiversitylibrary.org/item/28953",
              "Pages": [
                {
                  "PageID": 5904859,
                  "ItemID": "28953",
                  "TextSource": "OCR",
                  "PageUrl": "https://www.biodiversitylibrary.org/page/5904859",
                  "ThumbnailUrl": "https://www.biodiversitylibrary.org/pagethumb/5904859",
                  "FullSizeImageUrl": "https://www.biodiversitylibrary.org/pageimage/5904859",
                  "OcrUrl": "https://www.biodiversitylibrary.org/pagetext/5904859",
                  "PageTypes": [
                    {
                      "PageTypeName": "Text"
                    }
                  ],
                  "PageNumbers": [
                    {
                      "Prefix": "Page",
                      "Number": "754"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}