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

GetPageMetadata
Return metadata about a page. You may choose to include the text and a list of names found on the page.
SYNTAX
https://www.biodiversitylibrary.org/api3?op=GetPageMetadata
&pageid=<BHL identifier of a page>
&ocr=<"t" or "true" to include the page text in the response>
&names=<"t" or "true" to include scientific names on the page in the response>
&format=<"xml" for an XML response or "json" for JSON (OPTIONAL; "xml" is the default)>
&apikey=<API key value>
EXAMPLE REQUEST (XML)
            
https://www.biodiversitylibrary.org/api3?op=GetPageMetadata&pageid=3137380&ocr=t&names=t&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>
  <Result>
    <Page>
      <PageID>3137380</PageID>
      <ItemID>22314</ItemID>
      <TextSource>OCR</TextSource>
      <PageUrl>https://www.biodiversitylibrary.org/page/3137380</PageUrl>
      <ThumbnailUrl>https://www.biodiversitylibrary.org/pagethumb/3137380</ThumbnailUrl>
      <FullSizeImageUrl>https://www.biodiversitylibrary.org/pageimage/3137380</FullSizeImageUrl>
      <OcrUrl>https://www.biodiversitylibrary.org/pagetext/3137380</OcrUrl>
      <OcrText>
        CONTENTS OF VOLUME X
        Plates 1-9

        PAGE

        Title-page i

        Contents Hi

        A Further Study of Variation in the Gopher-Snakes of Western North

        America, by John Van Denburgh 1

        (Published August 6, 1920)

        Description of a New Species of Rattlesnake (Crotalus lucasensis) from

        Lower California, by John Van Denburgh 29

        (Published August 6, 1920)

        Description of a New Subspecies of Boa (Charina bottce utaliensis) from

        Utah, by John Van Denburgh 31

        (Published August 6, 1920)

        Description of a New Lizard (Dipsosaurus dorsalis lucasensis) from

        Lower California, by John Van Denburgh : 33

        (Published August 6, 1920)

        Undescribed Tipulidae (Diptera) from Western North America, by

        Charles P. Alexander 35

        (Published August 6, 1920)

        Three New Species of Dolichopodidae (Diptera) from California and

        Nevada, by M. C. Van Duzee _ 47

        (Published August 6, 1920)

        Two New Species of Syrphidse (Diptera), by A. L. Lovett 51

        (Published August 6, 19^)

        Notes on Some Undescribed Calif ornian Helices, by S. Stillman Berry.... 53

        (Published August 11, 1920)

        A New Genus and Species of Grasshopper from California, by Morgan

        Hebard _ 71

        (Published December 29, 1920)

        Color Changes and Structure of the Skin of Anolis carolinensis, by

        Charles E. von Geldern 77

        (Published February 12, 1921)

        Report of the President of the Academy for the Year 1920, by C. E.

        Grunsky 119

        (Published July 2, 1921)

        Report of the Director of the Museum for the Year 1920, by Barton

        Warren Evermann 128

        (Published July 2, 1921)

        Index 165

        JUNE 11, 1923

      </OcrText>
      <CreationDate>2008/04/16 12:27:04</CreationDate>
      <PageTypes>
        <PageType>
          <PageTypeName>Table of Contents</PageTypeName>
        </PageType>
      </PageTypes>
      <PageNumbers />
      <Names>
        <Name>
          <NameFound>Anolis carolinensis</NameFound>
          <NameConfirmed>Anolis carolinensis</NameConfirmed>
          <NameCanonical>Anolis carolinensis</NameCanonical>
        </Name>
        <Name>
          <NameFound>Charina</NameFound>
          <NameConfirmed>Charina</NameConfirmed>
          <NameCanonical>Charina</NameCanonical>
        </Name>
        <Name>
          <NameFound>Crotalus lucasensis</NameFound>
          <NameConfirmed>Crotalus lucasensis VAN 1920</NameConfirmed>
          <NameCanonical>Crotalus lucasensis</NameCanonical>
        </Name>
        <Name>
          <NameFound>Dipsosaurus dorsalis lucasensis</NameFound>
          <NameConfirmed>Dipsosaurus dorsalis lucasensis</NameConfirmed>
          <NameCanonical>Dipsosaurus dorsalis lucasensis</NameCanonical>
        </Name>
        <Name>
          <NameFound>Diptera</NameFound>
          <NameConfirmed>Diptera</NameConfirmed>
          <NameCanonical>Diptera</NameCanonical>
        </Name>
        <Name>
          <NameFound>Dolichopodidae</NameFound>
          <NameConfirmed>Dolichopodidae</NameConfirmed>
          <NameCanonical>Dolichopodidae</NameCanonical>
        </Name>
        <Name>
          <NameFound>Tipulidae</NameFound>
          <NameConfirmed>Tipulidae</NameConfirmed>
          <NameCanonical>Tipulidae</NameCanonical>
        </Name>
      </Names>
    </Page>
  </Result>
</Response>
            
        
EXAMPLE REQUEST (JSON)
            
https://www.biodiversitylibrary.org/api3?op=GetPageMetadata&pageid=3137380&ocr=t&names=t&format=json&apikey=12345678-BBBB-DDDD-FFFF-123456789012
            
        
EXAMPLE RESPONSE (JSON)
            
{
  "Status": "ok",
  "ErrorMessage": "",
  "Result": [
    {
      "PageID": 3137380,
      "ItemID": "22314",
      "TextSource": "OCR",
      "PageUrl": "https://www.biodiversitylibrary.org/page/3137380",
      "ThumbnailUrl": "https://www.biodiversitylibrary.org/pagethumb/3137380",
      "FullSizeImageUrl": "https://www.biodiversitylibrary.org/pageimage/3137380",
      "OcrUrl": "https://www.biodiversitylibrary.org/pagetext/3137380",
      "OcrText": "CONTENTS OF VOLUME X \n\n Plates 1-9 \n\n\n\nPAGE \n\n\n\nTitle-page i \n\n\n\nContents Hi \n\n\n\nA Further Study of Variation in the Gopher-Snakes of Western North \n\n\n\nAmerica, by John Van Denburgh 1 \n\n\n\n(Published August 6, 1920) \n\n\n\nDescription of a New Species of Rattlesnake (Crotalus lucasensis) from \n\n\n\nLower California, by John Van Denburgh 29 \n\n\n\n(Published August 6, 1920) \n\n\n\nDescription of a New Subspecies of Boa (Charina bottce utaliensis) from \n\n\n\nUtah, by John Van Denburgh 31 \n\n\n\n(Published August 6, 1920) \n\n\n\nDescription of a New Lizard (Dipsosaurus dorsalis lucasensis) from \n\n\n\nLower California, by John Van Denburgh : 33 \n\n\n\n(Published August 6, 1920) \n\n\n\nUndescribed Tipulidae (Diptera) from Western North America, by \n\n\n\nCharles P. Alexander 35 \n\n\n\n(Published August 6, 1920) \n\n\n\nThree New Species of Dolichopodidae (Diptera) from California and \n\n\n\nNevada, by M. C. Van Duzee _ 47 \n\n\n\n(Published August 6, 1920) \n\n\n\nTwo New Species of Syrphidse (Diptera), by A. L. Lovett 51 \n\n\n\n(Published August 6, 19^) \n\n\n\nNotes on Some Undescribed Calif ornian Helices, by S. Stillman Berry.... 53 \n\n\n\n(Published August 11, 1920) \n\n\n\nA New Genus and Species of Grasshopper from California, by Morgan \n\n\n\nHebard _ 71 \n\n\n\n(Published December 29, 1920) \n\n\n\nColor Changes and Structure of the Skin of Anolis carolinensis, by \n\n\n\nCharles E. von Geldern 77 \n\n\n\n(Published February 12, 1921) \n\n\n\nReport of the President of the Academy for the Year 1920, by C. E. \n\n\n\nGrunsky 119 \n\n\n\n(Published July 2, 1921) \n\n\n\nReport of the Director of the Museum for the Year 1920, by Barton \n\n\n\nWarren Evermann 128 \n\n\n\n(Published July 2, 1921) \n\n\n\nIndex 165 \n\n\n\nJUNE 11, 1923 \n\n\n\n",
      "CreationDate": "2008/04/16 12:27:04",
      "PageTypes": [
        {
          "PageTypeName": "Table of Contents"
        }
      ],
      "PageNumbers": [],
      "Names": [
        {
          "NameFound": "Anolis carolinensis",
          "NameConfirmed": "Anolis carolinensis Duméril & Bibron, 1837",
          "NameCanonical": "Anolis carolinensis"
        },
        {
          "NameFound": "Charina",
          "NameConfirmed": "Charina",
          "NameCanonical": "Charina"
        },
        {
          "NameFound": "Crotalus lucasensis",
          "NameConfirmed": "Crotalus lucasensis VAN 1920",
          "NameCanonical": "Crotalus lucasensis"
        },
        {
          "NameFound": "Dipsosaurus dorsalis lucasensis",
          "NameConfirmed": "Dipsosaurus dorsalis lucasensis VAN DENBURGH 1920",
          "NameCanonical": "Dipsosaurus dorsalis lucasensis"
        },
        {
          "NameFound": "Diptera",
          "NameConfirmed": "Diptera",
          "NameCanonical": "Diptera"
        },
        {
          "NameFound": "Dolichopodidae",
          "NameConfirmed": "Dolichopodidae",
          "NameCanonical": "Dolichopodidae"
        },
        {
          "NameFound": "Tipulidae",
          "NameConfirmed": "Tipulidae",
          "NameCanonical": "Tipulidae"
        }
      ]
    }
  ]
}