Using COPO Programmatically
The COPO API [1] is a RESTful [2] web service that enables users to access and interact with the COPO system, either programmatically or through the user interface. It is built using the Swagger (OpenAPI) framework and is accessible at: https://copo-project.org/api.
Hint
The button, 
, indicates that the API method
endpoints will produce results from the website host server i.e. if the
live COPO website is used to query the endpoint, then, the live results
will be retrieved while the opposite occurs if one uses the demo website
to query the API method endpoints.
API End-points
The COPO API [1] includes endpoints for audit, manifest, sample, profile, statistics and mapping data. Results can be downloaded in CSV format or viewed in JSON or Ro-Crate [3] formats depending on the record type as shown in the table below.
Most endpoints support querying by a specific metadata standard. Refer to the Available Standards for Records table for details on which standards are supported for each record type. This flexibility promotes interoperability with other systems that comply with different standards.
By default, API endpoints return data in the Tree of Life (ToL) standard and in JSON format, unless a different standard or format is specified.
All results contain metadata submitted by the original data providers.
Output Format |
Available Record Types |
|---|---|
csv |
Audit, Sample, Manifest |
json |
Audit, Sample, Manifest |
json-ld |
Profile |
ro-crate |
Sample |
xlsx |
Profile |
Standard |
Backronym |
Available Records Types |
|---|---|---|
dwc |
Darwin Core |
Sample, Manifest |
ena |
European Nucleotide Archive |
Sample, Manifest |
mixs |
Minimum Information about any (x) Sequence |
Sample, Manifest |
tol |
Tree of Life |
Sample, Manifest |
See the following sections for details on each category of API endpoints:
Footnotes