Try in sandboxSign-in required · shared test environment
POST/api/search_own/
Send JSON over HTTPS with your assigned api_key in the body. Use the appropriate test or production host.
Request body
OwnRequest
Protocol requirements come from OpenAPI 0.4.1. Credentials are required for access. Gear submissions must also satisfy the required and conditional Data Rules, even where the test schema allows omissions.
| Field / type | Requirement | Description |
|---|---|---|
format_version number | Optional | File Format Version, currently 0.3 Default: 0.3 |
api_key string · min length 32, max length 38 | Required for access | API credential. Keep credentials server-side and redact them from logs and support reports. |
max_sets integer · min 1, max 100000 | null | Optional | Maximum number of sets to return. Default is 10,000. Maximum is 100,000 Default: 10000 |
status TrapStatus | null | Optional | Current status of gear View TrapStatus fields |
from_latitude number · min -90, max 90 | null | Optional | Latitude Default: -90 |
to_latitude number · min -90, max 90 | null | Optional | Latitude Default: 90 |
from_longitude number · min -180, max 180 | null | Optional | From Longitude Default: -180 |
to_longitude number · min -180, max 180 | null | Optional | To Longitude Default: 180 |
start_datetime_utc string (date-time) | Optional | Allows gathering of data since last download. Default: "1970-01-01T00:00:00Z" |
start_deploy_utc string (date-time) | null | Optional | Starting deploy date/time. ISO 8601 UTC Default: "1970-01-01T00:00:00Z" |
end_deploy_utc string (date-time) | null | Optional | Ending deploy date/time. ISO 8601 UTC Default: "2050-01-01T00:00:00Z" |
start_retrieve_utc string (date-time) | null | Optional | Include data for traps retrieved on or after this date/time. ISO 8601 UTC |
end_retrieve_utc string (date-time) | null | Optional | Include data for traps retrieved on or before this date/time. ISO 8601 UTC |
trap_id string · min length 32, max length 38 | null | Optional | Gear ID |
set_id string · min length 32, max length 38 | null | Optional | UUID unique to this set. |
TrapStatus
deployed | retrieved | lost
Example request
Replace the credential placeholder with your test key in your server-side client. This request limits the number of returned sets to 100; a capped response is not a complete synchronization.
{
"api_key": "YOUR_TEST_API_KEY",
"format_version": 0.3,
"max_sets": 100,
"start_datetime_utc": "1970-01-01T00:00:00Z",
"status": "deployed"
}Response
HTTP 200 · OwnResponse
The published response model describes possible fields. Your category, record sharing and field approvals determine the data you may receive.
| Field / type | Requirement | Description |
|---|---|---|
format_version number | Optional | Default: 0.3 |
as_of_utc string (date-time) | Optional | Response synchronization timestamp. Save only after successfully processing the response. |
api_key string | Optional | API credential. Keep credentials server-side and redact them from logs and support reports. |
sets array<Set> | Optional | View Set fields |
Returned sets use the Set and Trap fields. The linked tables describe submission obligations; receiving the full model remains subject to access permissions.
Errors and updates
HTTP 422 returns validation errors in detail, including loc (field
location), msg (message) and type. Handle other HTTP errors and
connection failures as well.
Use start_datetime_utc to request changes since the last successful download. Process the returned records before saving the response’s as_of_utc timestamp.
max_sets defaults to 10,000 and permits 1–100,000. No pagination cursor is defined.
If a response reaches the limit, do not assume synchronization is complete or advance past unprocessed
records; confirm a complete retrieval strategy with Polaris.
The upstream 0.4.1 notes mention ALL_DATA, but the published request model
does not define its syntax. Confirm support with Polaris before relying on all-status
retrieval.
HTTPValidationError
| Field / type | Requirement | Description |
|---|---|---|
detail array<ValidationError> | Optional | View ValidationError fields |
ValidationError
| Field / type | Requirement | Description |
|---|---|---|
loc array<string | integer> | Required | |
msg string | Required | |
type string | Required | |
input any | Optional | |
ctx object | Optional |