The PTAGIS API is primarily used by PTAGIS software to submit PIT tag data and retrieve metadata, however there are a few endpoints that provide limited querying of PIT tag data and metadata. This section describes some of the endpoints that may be useful to PTAGIS data users. See the PTAGIS API documentation for details about each endpoint and how to use them.
Data Endpoints
The Data endpoints provide limited access to PIT tag data through the API. The intended use is to query basic information about a few tags at a time for display, rather than to query large amounts of PIT tag data for analysis. The endpoints that take a PIT tag code as a parameter should not be used to query more than a thousand tags a day and there should be a couple of seconds between calls. The endpoints that return all unique observations for one site should be used with restraint, especially if targeting one of the mainstem interrogation sites.
Use of the data endpoints requires an API key, which can be requested by contacting PTAGIS.
Reporting Endpoints
If you are looking to automate querying and retrieving large results sets of PIT tag data from PTAGIS, the advanced reporting system is the best option at this time. The advanced reporting system includes tools to build and save custom queries that can be run on a schedule. This allows the results set to be exported automatically on a scheduled to a file (CSV, TXT, or XSLX) which can then be retrieved programmatically through the API. The Reporting endpoints can be used to query for a list of exported report files by user name or to download a particular file by user name and file name.
Data File Endpoints
The Interrogation Data File and MRR Data File endpoints allow the listing and download of one or more data files from the PTAGIS file repository.
Metadata Data Endpoints
Several endpoints are available to retrieve metadata about interrogation sites and MRR sites; PIT tags distributed by PTAGIS for BPA, and PTAGIS validation codes.
Version: 1.08
Published: 11/12/2024