Skip to main content

Documentation Index

Fetch the complete documentation index at: https://code4source.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

A source is a curated dataset — typically a register of polygons or a list of subject identifiers — used as the right-hand side of a match. Examples:
  • br:funai:indigenous-territories — official indigenous land registry
  • br:ibama:embargoed-areas — environmental-violation embargoes
  • br:icmbio:conservation-units — federal conservation areas
  • ofac:sdn — US OFAC Specially Designated Nationals list
  • br:car:rural-properties — Rural Environmental Registry

​
Listing what’s available

GET /v1/sources
Returns metadata for every source your Organization can reach — name, kind, country coverage, and last refresh timestamp. Filter by kind: 
GET /v1/sources?kind=subject_register
Three kinds exist:
  • leaf — a regular spatial source.
  • group — a virtual collection that expands to several leaves; selecting a group is equivalent to querying all of its members.
  • subject_register — non-spatial source keyed by typed identifiers (CNPJ, EIN, OFAC SDN). Carries a supported_schemes list.

​
Freshness

Each source carries collected_at_latest — the timestamp of its most recent refresh. We refresh sources on a schedule appropriate to each upstream’s update cadence. If an upstream is unreachable at query time, the affected check is marked failed and the verdict’s status becomes degraded. Your request still returns 2xx with the partial result so you can decide how to handle it.

​
Referencing sources

In a ruleset: 
{
  "sets": {
    "protected_overlap": {
      "source": "br:icmbio:conservation-units",
      "join": { "op": "intersects", "target": "$input" }
    }
  }
}
In /v1/intersections and /v1/distance, you can either query against all sources at once (default) or restrict to a specific one via reference_areas_source.