Locations
Low-zoom map clusters. Returns geohash aggregates as { point: {lat, lon}, count } using the same sample filters as GET /api/samples/. Use bbox=min_lon,min_lat,max_lon,max_lat, precision, and size.
Token-based authentication with required prefix "Token"
Upper bound on numeric age (numeric_age_max ≤ value).
Lower bound on numeric age (numeric_age_min ≥ value).
Restrict to samples registered in this batch history PK (requires view permission on the batch).
WGS84 bounding box as min_lon,min_lat,max_lon,max_lat.
Annotates rows linked to this related-resource primary key (used with list UI).
Samples with sampling_start_date on or after this instant.
Samples with sampling_end_date on or before this instant.
Substring match on individual or institution collector label.
Continent code or label (exact field match on continent).
Country ISO 3166 code(s), comma-separated (e.g. US,CA).
Substring match on current archive label or alt label.
Samples with depth_max ≤ this value.
Samples with depth_min ≥ this value.
Case-insensitive substring match on sample_description.
Samples with elevation ≤ this value (meters).
Samples with elevation ≥ this value (meters).
If true, only top-level samples (parent_sample empty).
Exact match on external_sample_id.
Case-insensitive match on material name verbatim (material_name_verbatim).
Reserved pass-through (same allowlist as list views).
Substring match across locality, province, location fields, etc.
Substring match on geologic_age_verbatim or geologic_unit.
If true, only samples with non-null numeric_age_min, numeric_age_max, or geologic_age_verbatim.
If true, only samples with a non-null geom_latlong.
If true, only samples with a related resource of type Image.
If true, samples with linked resources excluding Image.
Exact case-insensitive related-resource type label (e.g. publication type labels).
Case-insensitive substring match on IGSN.
Substring match on initiative label or normalized label linked as cruise/program.
Restrict to samples linked to this initiative PK (requires view permission on initiative).
If true, only drafts (authenticated, owner contexts). If false, exclude drafts.
Substring match on launch platform label or normalized label.
Restrict to samples using this launch platform PK (requires view permission).
Comma-separated material type IDs; expands to descendants for FK and M2M material match.
Case-insensitive substring match on sample name.
Object type label(s); matches object_type__in.
Sort field(s). Prefix - for descending (same as DRF OrderingFilter).
Page number when using paginated list endpoints.
Page size when using paginated list endpoints.
Substring match on platform label or normalized label.
Restrict to samples using this platform PK (requires view permission).
WKT POINT (POINT(lon lat)); use with optional radius (meters, default 1000).
WKT or GeoJSON geometry; samples with geom_latlong inside the polygon (SRID 4326 if omitted).
Geohash precision 1–12 for clusters (default 3).
Samples with publish_date ≥ this instant.
Samples with publish_date ≤ this instant.
Search substring matched against IGSN or name.
Radius in meters around point (ignored without point).
Samples with registration_date ≥ this instant.
Samples with registration_date ≤ this instant.
Samples linked to this related resource PK (requires view permission).
Samples in this sample group PK (requires view permission on the group).
Case-insensitive match on linked sampling method label.
Visibility: public (published metadata), personal (your samples), shared (SESAR code grants), personal_and_shared; other values fall back to authenticated/public rules per server logic.
SESAR code(s); matches sesar_code__in.
Max clusters / groups / point rows to return.
Restrict to samples owned by this team (must be authenticated member).
Invalid spatial parameters
GET /api/locations/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"status": "text",
"count": 1,
"data": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
]
}Detail rows near a clicked map coordinate. Requires point=POINT(lon lat) and optional radius in meters.
Token-based authentication with required prefix "Token"
Upper bound on numeric age (numeric_age_max ≤ value).
Lower bound on numeric age (numeric_age_min ≥ value).
Restrict to samples registered in this batch history PK (requires view permission on the batch).
WGS84 bounding box as min_lon,min_lat,max_lon,max_lat.
Annotates rows linked to this related-resource primary key (used with list UI).
Samples with sampling_start_date on or after this instant.
Samples with sampling_end_date on or before this instant.
Substring match on individual or institution collector label.
Continent code or label (exact field match on continent).
Country ISO 3166 code(s), comma-separated (e.g. US,CA).
Substring match on current archive label or alt label.
Samples with depth_max ≤ this value.
Samples with depth_min ≥ this value.
Case-insensitive substring match on sample_description.
Samples with elevation ≤ this value (meters).
Samples with elevation ≥ this value (meters).
If true, only top-level samples (parent_sample empty).
Exact match on external_sample_id.
Case-insensitive match on material name verbatim (material_name_verbatim).
Reserved pass-through (same allowlist as list views).
Substring match across locality, province, location fields, etc.
Substring match on geologic_age_verbatim or geologic_unit.
If true, only samples with non-null numeric_age_min, numeric_age_max, or geologic_age_verbatim.
If true, only samples with a non-null geom_latlong.
If true, only samples with a related resource of type Image.
If true, samples with linked resources excluding Image.
Exact case-insensitive related-resource type label (e.g. publication type labels).
Case-insensitive substring match on IGSN.
Substring match on initiative label or normalized label linked as cruise/program.
Restrict to samples linked to this initiative PK (requires view permission on initiative).
If true, only drafts (authenticated, owner contexts). If false, exclude drafts.
Substring match on launch platform label or normalized label.
Restrict to samples using this launch platform PK (requires view permission).
Comma-separated material type IDs; expands to descendants for FK and M2M material match.
Case-insensitive substring match on sample name.
Object type label(s); matches object_type__in.
Sort field(s). Prefix - for descending (same as DRF OrderingFilter).
Page number when using paginated list endpoints.
Page size when using paginated list endpoints.
Substring match on platform label or normalized label.
Restrict to samples using this platform PK (requires view permission).
WKT POINT (POINT(lon lat)); use with optional radius (meters, default 1000).
WKT or GeoJSON geometry; samples with geom_latlong inside the polygon (SRID 4326 if omitted).
Geohash precision 1–12 for clusters (default 3).
Samples with publish_date ≥ this instant.
Samples with publish_date ≤ this instant.
Search substring matched against IGSN or name.
Radius in meters around point (ignored without point).
Samples with registration_date ≥ this instant.
Samples with registration_date ≤ this instant.
Samples linked to this related resource PK (requires view permission).
Samples in this sample group PK (requires view permission on the group).
Case-insensitive match on linked sampling method label.
Visibility: public (published metadata), personal (your samples), shared (SESAR code grants), personal_and_shared; other values fall back to authenticated/public rules per server logic.
SESAR code(s); matches sesar_code__in.
Max clusters / groups / point rows to return.
Restrict to samples owned by this team (must be authenticated member).
Missing or invalid spatial parameters
GET /api/locations/point/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"status": "text",
"count": 1,
"data": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
]
}Higher-zoom location markers grouped by parent/root sample. Each group includes nested sample stubs and a representative point.
Token-based authentication with required prefix "Token"
Upper bound on numeric age (numeric_age_max ≤ value).
Lower bound on numeric age (numeric_age_min ≥ value).
Restrict to samples registered in this batch history PK (requires view permission on the batch).
WGS84 bounding box as min_lon,min_lat,max_lon,max_lat.
Annotates rows linked to this related-resource primary key (used with list UI).
Samples with sampling_start_date on or after this instant.
Samples with sampling_end_date on or before this instant.
Substring match on individual or institution collector label.
Continent code or label (exact field match on continent).
Country ISO 3166 code(s), comma-separated (e.g. US,CA).
Substring match on current archive label or alt label.
Samples with depth_max ≤ this value.
Samples with depth_min ≥ this value.
Case-insensitive substring match on sample_description.
Samples with elevation ≤ this value (meters).
Samples with elevation ≥ this value (meters).
If true, only top-level samples (parent_sample empty).
Exact match on external_sample_id.
Case-insensitive match on material name verbatim (material_name_verbatim).
Reserved pass-through (same allowlist as list views).
Substring match across locality, province, location fields, etc.
Substring match on geologic_age_verbatim or geologic_unit.
If true, only samples with non-null numeric_age_min, numeric_age_max, or geologic_age_verbatim.
If true, only samples with a non-null geom_latlong.
If true, only samples with a related resource of type Image.
If true, samples with linked resources excluding Image.
Exact case-insensitive related-resource type label (e.g. publication type labels).
Case-insensitive substring match on IGSN.
Substring match on initiative label or normalized label linked as cruise/program.
Restrict to samples linked to this initiative PK (requires view permission on initiative).
If true, only drafts (authenticated, owner contexts). If false, exclude drafts.
Substring match on launch platform label or normalized label.
Restrict to samples using this launch platform PK (requires view permission).
Comma-separated material type IDs; expands to descendants for FK and M2M material match.
Case-insensitive substring match on sample name.
Object type label(s); matches object_type__in.
Sort field(s). Prefix - for descending (same as DRF OrderingFilter).
Page number when using paginated list endpoints.
Page size when using paginated list endpoints.
Substring match on platform label or normalized label.
Restrict to samples using this platform PK (requires view permission).
WKT POINT (POINT(lon lat)); use with optional radius (meters, default 1000).
WKT or GeoJSON geometry; samples with geom_latlong inside the polygon (SRID 4326 if omitted).
Geohash precision 1–12 for clusters (default 3).
Samples with publish_date ≥ this instant.
Samples with publish_date ≤ this instant.
Search substring matched against IGSN or name.
Radius in meters around point (ignored without point).
Samples with registration_date ≥ this instant.
Samples with registration_date ≤ this instant.
Samples linked to this related resource PK (requires view permission).
Samples in this sample group PK (requires view permission on the group).
Case-insensitive match on linked sampling method label.
Visibility: public (published metadata), personal (your samples), shared (SESAR code grants), personal_and_shared; other values fall back to authenticated/public rules per server logic.
SESAR code(s); matches sesar_code__in.
Max clusters / groups / point rows to return.
Restrict to samples owned by this team (must be authenticated member).
Invalid spatial parameters
GET /api/locations/samples/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
"status": "text",
"count": 1,
"data": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
]
}Last updated
Was this helpful?