# Vantage API

REST API for queuing and running geospatial analyses on user plots. Create jobs, validate and queue plots, and retrieve per-plot analysis results (e.g., EUDR, deforestation, protected areas).

Version: 3.0.1
License: OpenAtlas - User License Agreement

## Download OpenAPI description

[Vantage API](https://api.open-atlas.com/_bundle/openapi.yaml)

## Protected Areas

### Check protected-areas overlap

 - [POST /protected-areas/checks](https://api.open-atlas.com/openapi/protected-areas/runprotectedareasanalysis.md): Accepts a JSON object with 'plot_ids' (array of strings) and/or 'geojson' (At least one of the two fields must be provided). Returns a single GeoJSON FeatureCollection with all results.

### Fetch protected area details

 - [GET /protected-areas/{area_id}](https://api.open-atlas.com/openapi/protected-areas/getprotectedareabyid.md): Returns a GeoJSON FeatureCollection for the protected area with the given area_id.

## Other

### Login to receive a JWT

 - [POST /login](https://api.open-atlas.com/openapi/other/login.md): Authenticates a user using Basic Auth credentials and returns a JWT token if successful.

### Create a new plot

 - [POST /plots/make_plot](https://api.open-atlas.com/openapi/other/createplot.md): Creates a new plot based on the given geojson and metadata

### Retrieve plot details

 - [GET /plots/plot/{plot_id}](https://api.open-atlas.com/openapi/other/getplot.md): Fetches details of a specific plot by its unique plot_id

### List user's plots

 - [GET /plots](https://api.open-atlas.com/openapi/other/listuserplots.md): Returns the authenticated user's plots with keyset pagination (newest first).

### List analysis runs for a plot

 - [GET /analysis-runs](https://api.open-atlas.com/openapi/other/listrunsforplot.md): Returns all analysis runs associated with the provided plot_id. Each item summarizes the run, including status, timing, tokens cost, and links to artifacts.

### Retrieve analysis run details

 - [GET /analysis-runs/{run_id}](https://api.open-atlas.com/openapi/other/getanalysisbyrunid.md): Returns the full analysis run details for the provided run_id, including analysis output, status, configuration used, and artifact links.

### Create a new job

 - [POST /jobs/make_job](https://api.open-atlas.com/openapi/other/createjob.md): Creates a new job based on the given list of plot_ids. Warning: This operation will consume user tokens

### Retrieve job details

 - [GET /jobs/job/{job_id}](https://api.open-atlas.com/openapi/other/getjob.md): Fetches details of a specific job by its unique job_id

### List user's jobs

 - [GET /jobs](https://api.open-atlas.com/openapi/other/listuserjobs.md): Returns the authenticated user's jobs with keyset pagination (newest first). Each job includes plot_ids and job_visualization_url (no embedded plot objects). The response includes a meta object with pagination info.

### Get token balance info

 - [GET /users/check_tokens](https://api.open-atlas.com/openapi/other/checktokens.md): Retrieves the total token balance, reserved tokens, and free tokens for the user associated with the provided Bearer token.