{"basePath":"/api_v1","consumes":["application/json"],"definitions":{"errorModel":{"properties":{"detail":{"description":"Brief description of the error","type":"string"},"status":{"description":"HTTP numeric status code","format":"int32","type":"integer"},"title":{"description":"HTTP status code description","type":"string"},"type":{"description":"MIME type or about:blank","type":"string"}},"required":["type","title","detail","status"],"type":"object"},"locale":{"properties":{"data_type":{"description":"Type of paleoecological or paleontological data","type":"string"},"doi":{"description":"Unique DOI for locale if available","type":"string"},"elevation":{"description":"Locale elevation","format":"double","type":"number"},"lat":{"description":"Locale latitude","format":"double","type":"number"},"locale_id":{"description":"DB specific locale","type":"string"},"locale_name":{"description":"Dataset or collection name","type":"string"},"lon":{"description":"Locale longitude","format":"double","type":"number"},"max_age":{"description":"Oldest possible age of the locale","format":"double","type":"number"},"min_age":{"description":"Youngest possible age of the locale","format":"double","type":"number"},"occurrences_count":{"description":"Number of occurrences in locale","format":"int32","type":"integer"},"site_id":{"description":"Unique identifier of a sample site if available","type":"string"},"source":{"description":"Sub-database or literature reference","type":"string"}},"type":"object"},"mobile":{"properties":{"eco":{"properties":{"dte":{"description":"Diet and feeding mode","type":"string"},"env":{"description":"Found environment","type":"string"},"grp":{"description":"Ecological/taxonomic grouping and basis","type":"string"},"hab":{"description":"Life habitat, grouping and depth","type":"string"},"mot":{"description":"Motility and attachment","type":"string"},"ont":{"description":"Ontology","type":"string"},"rep":{"description":"Mode of reproduction","type":"string"},"typ":{"description":"Collection/dataset type","type":"string"},"vis":{"description":"Vision capability","type":"string"}},"type":"object"},"loc":{"properties":{"age":{"description":"Age bounds (min,max)","type":"string"},"crd":{"description":"Modern geographic coordinates. GeoJSON WGS 84","type":"string"},"pla":{"description":"County, state/province, country","type":"string"},"ste":{"description":"Site/collection name, description","type":"string"}},"type":"object"},"org":{"properties":{"img":{"description":"Phylopic ID number. Retrieve as https://paleobiodb.org/data1.2/taxa/thumb.png?id=[img]","format":"int32","type":"integer"},"itv":{"description":"Existence geologic interval (eary,late)","type":"string"},"nam":{"description":"Organism common name","type":"string"},"sts":{"description":"Extinct or extant","type":"string"},"txn":{"description":"Taxonomic name","type":"string"}},"type":"object"},"src":{"description":"Providor database","type":"string"}},"type":"object"},"occurrence":{"properties":{"data_type":{"description":"Paleontological type","type":"string"},"elevation":{"description":"Locale elevation","format":"double","type":"number"},"lat":{"description":"Occurrence latitude in decimal degrees","format":"double","type":"number"},"locale_id":{"description":"Generated ID string reflection a dataset or collection","type":"string"},"lon":{"description":"Occurrence longitude in decimal degrees","format":"double","type":"number"},"max_age":{"description":"Oldest age of the occurrence","format":"double","type":"number"},"min_age":{"description":"Youngest age of the occurrence","format":"double","type":"number"},"occ_id":{"description":"Unique occurrence ID","type":"string"},"source":{"description":"Sub-database or literature reference","type":"string"},"taxon":{"description":"Taxonomic name","type":"string"},"taxon_id":{"description":"Unique taxonomic ID","type":"string"}},"type":"object"},"paleocoords":{"properties":{"age":{"description":"Numerial age (in specified units) or geological ICS age.","type":"string"},"modern_lat":{"description":"Original modern day latitude","format":"double","type":"number"},"modern_lon":{"description":"Original modern day longitude","format":"double","type":"number"},"paleo_lat":{"description":"Paleo converted decimal latitude","format":"double","type":"number"},"paleo_lon":{"description":"Paleo converted decimal longitude","format":"double","type":"number"}},"type":"object"},"reference":{"properties":{"authors":{"description":"Parsed list of author names","items":{"type":"string"},"type":"array"},"cite":{"description":"Formated APA citation. For legacy reasons, this is all that is currently available for Neotoma references","type":"string"},"doi":{"description":"Journal artical DOI","type":"string"},"editor":{"description":"Name of book editor","type":"string"},"journal":{"description":"Container for journal or book name, editors, pages and volume","type":"string"},"kind":{"description":"Nature of the reference publication. Journal, book etc.","type":"string"},"page_range":{"description":"Pages of journal article or book","type":"string"},"ref_id":{"description":"Unique database reference identifier","type":"string"},"title":{"description":"Title of the reference material","type":"string"},"vol_no":{"description":"Journal volume and number","type":"string"},"year":{"description":"Publication year of the reference material","type":"string"}},"type":"object"},"subtaxa":{"properties":{"taxa":{"description":"List of identified subtaxa","items":{"type":"string"},"type":"array"}},"type":"object"},"taxonomy":{"properties":{"attribution":{"description":"Original author and year","type":"string"},"common_name":{"description":"Colloquial name","type":"string"},"composition":{"description":"Skeletal composition. ","type":"string"},"diet":{"description":"General diet or feeding mode","type":"string"},"early_interval":{"description":"Earliest geologic age occurrence","type":"string"},"ecological_group":{"description":"General descriptive ecological grouping","type":"string"},"env_basis":{"description":"Taxon on which environment description is based","type":"string"},"environment":{"description":"General environment of organism","type":"string"},"habitat":{"description":"Life mode and locality","type":"string"},"late_interval":{"description":"Latest geologic age occurrence","type":"string"},"mobility":{"description":"Attachment, mobility and locomotion","type":"string"},"occurrences_count":{"description":"Number of occurence of the taxa in database if available","format":"int32","type":"integer"},"parent_id":{"description":"Unique ID of the parent taxa","type":"string"},"rank":{"description":"Taxonomic rank","type":"string"},"source":{"description":"Sub-database or literature reference","type":"string"},"status":{"description":"Extinct or extant","type":"string"},"subtaxa_count":{"description":"Number of child taxa","format":"int32","type":"integer"},"subtaxa_extant":{"description":"Number of child taxa that are extant","format":"int32","type":"integer"},"taxon":{"description":"Taxonomic name","type":"string"},"taxon_id":{"description":"Unique database specific ID","type":"string"}},"type":"object"},"timebound":{"properties":{"ics_color":{"description":"Standardized color hex for first geologic age in range","type":"string"},"max_age":{"description":"Oldest age in bound","type":"string"},"min_age":{"description":"Most recent (youngest) age in bound","type":"string"}},"type":"object"}},"info":{"contact":{"url":"https://earthlifeconsortium.org"},"description":"Composite interface for paleontological databases. Currently supports the Neotoma Paleoecology Database and PBDB (The Paleobiology Database). See full OpenAPI Specification and read the full documentation for detailed instructions. Please report issues on GitHub or by email.","title":"API Sandbox","version":"1.1.6"},"paths":{"/loc":{"get":{"description":"Return sampling locations in space and time. Sampling locations may include multiple taxon. Utilizes the dataset model from Neotoma and the collections data model from the PBDB","operationId":"loc","parameters":[{"description":"Unique numeric ID, or vector of IDs for dataset (dst) or collection (col) in the format of [database]:[datatype]:[numeric]","in":"query","name":"idlist","required":false,"type":"string"},{"description":"Either a POLYGON((...)) in WKT format or else a comma separated list of bounds: lonmin, latmin, lonmax, latmax. You can use this external tool to craft a correctly formated WKT descriptor","in":"query","name":"bbox","required":false,"type":"string"},{"description":"Comma separated numerical age range or comma separated geological age names. May be in any order or single named age.","in":"query","name":"agerange","required":false,"type":"string"},{"description":"The units for maxage and minage. Allowable units are YBP, Ka or Ma","in":"query","name":"ageunits","required":false,"type":"string"},{"description":"Specify modern or paleo geographic coordinates for the data return. Query parameters must still be modern day coordinates If paleocoordinates are not available in the database response, The modern coordinates will be converted using the Gplates model. Allowable parameters are 'modern' (default) or 'paleo'","in":"query","name":"coordtype","required":false,"type":"string"},{"description":"Limit the number of records in the response for large queries. Any whole number numerical value is accepted. Default is 999999 which infers no limit.","format":"int32","in":"query","name":"limit","required":false,"type":"integer"},{"description":"Begin the response from a designated point within the larger query. In this way, limit and offset can be used to produce serial queries to the API to avoid issues with larger responses","format":"int32","in":"query","name":"offset","required":false,"type":"integer"},{"description":"Response format. Allowable parameters JSON (default), CSV","in":"query","name":"output","required":false,"type":"string"},{"description":"Set to idx for locale id's only. Set to poll for statistics only. Otherwise, full return","in":"query","name":"show","required":false,"type":"string"},{"description":"Specify resource databases to use. Comma separated list of database names, default is 'all'.","in":"query","name":"run","required":false,"type":"string"}],"produces":["application/json","text/csv"],"responses":{"200":{"description":"Locale response","schema":{"items":{"$ref":"#/definitions/locale"},"type":"array"}},"default":{"description":"unexpected error","schema":{"$ref":"#/definitions/errorModel"}}},"summary":"Sample localities","tags":["Locale"],"x-swagger-router-controller":"swagger_server.controllers.locale_controller","x-tags":[{"tag":"Locale"}]}},"/misc/mobile":{"get":{"description":"Custom data objects appropriate for visulization.","operationId":"mobile","parameters":[{"description":"Comma separated list of taxonomic names. Wildcards (%) are accepted but setting 'includelower=True' (the default) is the recomended method for returning all subtaxa.","in":"query","name":"taxon","required":false,"type":"string"},{"description":"Either a POLYGON((...)) in WKT format or else a comma separated list of bounds: lonmin, latmin, lonmax, latmax. You can use this external tool to craft a correctly formated WKT descriptor","in":"query","name":"bbox","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"mobile response","schema":{"items":{"$ref":"#/definitions/mobile"},"type":"array"}},"default":{"description":"unexpected error","schema":{"$ref":"#/definitions/errorModel"}}},"summary":"Lightweight response","tags":["Mobile"],"x-swagger-router-controller":"swagger_server.controllers.misc_controller","x-tags":[{"tag":"Mobile"}]}},"/misc/paleocoords":{"get":{"description":"Returns latitude and longitude rotated into paleo-time using the GPlates model made available by the Macrostrat project.","operationId":"paleocoords","parameters":[{"description":"Comma separated decimal degrees as latitude (-90 to 90),longitude (-180 to 180) with negative values indicating southern latitudes and western longitudes.","in":"query","name":"coords","required":true,"type":"string"},{"description":"Numerical age up to ma 580 or named geologic age. This is a limit of the paleoreconstruction model used.","in":"query","name":"age","required":true,"type":"string"},{"description":"The units for maxage and minage. Allowable units are YBP, Ka or Ma","in":"query","name":"ageunits","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"paleocoords response","schema":{"items":{"$ref":"#/definitions/paleocoords"},"type":"array"}},"default":{"description":"unexpected error","schema":{"$ref":"#/definitions/errorModel"}}},"summary":"Paleocoodinates conversion","tags":["Paleocoordinates"],"x-swagger-router-controller":"swagger_server.controllers.misc_controller","x-tags":[{"tag":"Paleocoordinates"}]}},"/misc/subtaxa":{"get":{"description":"For a given taxon, retrieve all related lower taxonomic names optionally including synonyms.","operationId":"subtaxa","parameters":[{"description":"Single taxonomic name","in":"query","name":"taxon","required":true,"type":"string"},{"description":"Include taxonomic synonyms in response. True (default) or False.","in":"query","name":"synonyms","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"subtaxa response","schema":{"items":{"$ref":"#/definitions/subtaxa"},"type":"array"}},"default":{"description":"unexpected error","schema":{"$ref":"#/definitions/errorModel"}}},"summary":"Retrieve subtaxa","tags":["Subtaxa"],"x-swagger-router-controller":"swagger_server.controllers.misc_controller","x-tags":[{"tag":"Subtaxa"}]}},"/misc/timebound":{"get":{"description":"Returns oldest (maxage) and youngest (minage) given a specified numerical or geologic age name range.","operationId":"timebound","parameters":[{"description":"Comma separated numerical age range or comma separated geological age names. May be in any order or single named age.","in":"query","name":"agerange","required":true,"type":"string"},{"description":"The units for maxage and minage. Allowable units are YBP, Ka or Ma","in":"query","name":"ageunits","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"timebound response","schema":{"items":{"$ref":"#/definitions/timebound"},"type":"array"}},"default":{"description":"unexpected error","schema":{"$ref":"#/definitions/errorModel"}}},"summary":"Geologic timescale bounds","tags":["Timebound"],"x-swagger-router-controller":"swagger_server.controllers.misc_controller","x-tags":[{"tag":"Timebound"}]}},"/occ":{"get":{"description":"Return fossil occurrences from the Paleobiology (PBDB) and Neotoma Databases.","operationId":"occ","parameters":[{"description":"Comma separated list of taxonomic names. Wildcards (%) are accepted but setting 'includelower=True' (the default) is the recomended method for returning all subtaxa.","in":"query","name":"taxon","required":false,"type":"string"},{"description":"Either a POLYGON((...)) in WKT format or else a comma separated list of bounds: lonmin, latmin, lonmax, latmax. You can use this external tool to craft a correctly formated WKT descriptor","in":"query","name":"bbox","required":false,"type":"string"},{"description":"Comma separated numerical age range or comma separated geological age names. May be in any order or single named age.","in":"query","name":"agerange","required":false,"type":"string"},{"description":"The units for maxage and minage. Allowable units are YBP, Ka or Ma","in":"query","name":"ageunits","required":false,"type":"string"},{"description":"Specify modern or paleo geographic coordinates for the data return. Query parameters must still be modern day coordinates If paleocoordinates are not available in the database response, The modern coordinates will be converted using the Gplates model. Allowable parameters are 'modern' (default) or 'paleo'","in":"query","name":"coordtype","required":false,"type":"string"},{"description":"Retrieve lower taxa. All species and subspecies of a named genera will be included in the response. True (default) or False.","in":"query","name":"includelower","required":false,"type":"boolean"},{"description":"Limit the number of records in the response for large queries. Any whole number numerical value is accepted. Default is 999999 which infers no limit.","format":"int32","in":"query","name":"limit","required":false,"type":"integer"},{"description":"Begin the response from a designated point within the larger query. In this way, limit and offset can be used to produce serial queries to the API to avoid issues with larger responses","format":"int32","in":"query","name":"offset","required":false,"type":"integer"},{"description":"Response format. Allowable parameters JSON (default), CSV","in":"query","name":"output","required":false,"type":"string"},{"description":"Set to idx for occurrence id's only. Set to poll for statistics only. Otherwise, full return","in":"query","name":"show","required":false,"type":"string"},{"description":"Specify resource databases to use. Comma separated list of database names, default is 'all'.","in":"query","name":"run","required":false,"type":"string"}],"produces":["application/json","text/csv"],"responses":{"200":{"description":"occurrence response","schema":{"items":{"$ref":"#/definitions/occurrence"},"type":"array"}},"default":{"description":"unexpected error","schema":{"$ref":"#/definitions/errorModel"}}},"summary":"Fossil occurrences in a specific place and time","tags":["Occurrence"],"x-swagger-router-controller":"swagger_server.controllers.occurrence_controller","x-tags":[{"tag":"Occurrence"}]}},"/ref":{"get":{"description":"Uses unique locale IDs or occurrence IDs to return the set of references associated with a query to enable citation","operationId":"ref","parameters":[{"description":"Unique numeric ID, or vector of IDs for dataset (dst) or collection (col) in the format of [database]:[datatype]: [numeric]","in":"query","name":"idlist","required":false,"type":"string"},{"description":"Response format. Allowable parameters are BibJSON (default), JSON, CSV and RIS","in":"query","name":"output","required":false,"type":"string"},{"description":"Set to idx for locale id's only. Set to poll for statistics only. Otherwise, full return","in":"query","name":"show","required":false,"type":"string"},{"description":"Specify resource databases to use. Comma separated list of database names, default is 'all'.","in":"query","name":"run","required":false,"type":"string"}],"produces":["application/json","text/csv","text/plain"],"responses":{"200":{"description":"reference response","schema":{"items":{"$ref":"#/definitions/reference"},"type":"array"}},"default":{"description":"unexpected error","schema":{"$ref":"#/definitions/errorModel"}}},"summary":"Scientific references associated with locales (datasets or collections) and occurrences","tags":["Reference"],"x-swagger-router-controller":"swagger_server.controllers.reference_controller","x-tags":[{"tag":"Reference"}]}},"/tax":{"get":{"description":"Returns detailed taxonomic information for the given query. Queries may include partial matches, and may request lower taxa using the boolean includelower parameter. In cases where hierarchy is also requested the user may set hierarchy to TRUE","operationId":"tax","parameters":[{"description":"Comma separated list of taxonomic names. Wildcards (%) are accepted but setting 'includelower=True' is the recomended method for returning all subtaxa.","in":"query","name":"taxon","required":false,"type":"string"},{"description":"Unique numeric ID, or vector of IDs for dataset (dst) or collection (col) in the format of [database]:[datatype]: [numeric]","in":"query","name":"idlist","required":false,"type":"string"},{"description":"Retrieve lower taxa. All species and subspecies of a named genera will be included in the response. False (default) or True.","in":"query","name":"includelower","required":false,"type":"boolean"},{"description":"Response format. Allowable parameters JSON (default), CSV","in":"query","name":"output","required":false,"type":"string"},{"description":"Set to idx for taxonomic id's only. Set to poll for statistics only. Otherwise, full return","in":"query","name":"show","required":false,"type":"string"},{"description":"Specify resource databases to use. Comma separated list of database names, default is 'all'.","in":"query","name":"run","required":false,"type":"string"}],"produces":["application/json","text/csv"],"responses":{"200":{"description":"taxon response","schema":{"items":{"$ref":"#/definitions/taxonomy"},"type":"array"}},"default":{"description":"unexpected error","schema":{"$ref":"#/definitions/errorModel"}}},"summary":"Taxonomic information, or hierarchy","tags":["Taxonomy"],"x-swagger-router-controller":"swagger_server.controllers.taxonomy_controller","x-tags":[{"tag":"Taxonomy"}]}}},"produces":["application/json","text/csv","text/plain"],"schemes":["https"],"swagger":"2.0"}