AgStack Foundation

AgStack Foundation Field Retrieval & Queries API

The Field Retrieval & Queries API from AgStack Foundation — 4 operation(s) for field retrieval & queries.

Documentation GitHub OpenAPI

Documentation

https://github.com/agstack/OpenAgri-WeatherService

https://github.com/agstack/OpenAgri-WeatherService/blob/main/README.md

https://github.com/agstack/OpenAgri-FarmCalendar

https://github.com/agstack/OpenAgri-FarmCalendar/blob/main/README.md

https://github.com/agstack/asset-registry

https://api-ar.agstack.org

Specifications

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/openapi/agstack-field-retrieval-queries-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-schema/agstack-openagri-weather-service-predictionout-schema.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-schema/agstack-openagri-weather-service-weatherdataout-schema.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-schema/agstack-openagri-weather-service-thidataout-schema.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-schema/agstack-openagri-weather-service-sprayforecastresponse-schema.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-schema/agstack-openagri-weather-service-flightstatusforecastresponse-schema.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-schema/agstack-openagri-weather-service-geojsonout-schema.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-schema/agstack-openagri-weather-service-jsonldgraph-schema.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-schema/agstack-openagri-weather-service-authtoken-schema.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-schema/agstack-openagri-weather-service-pointout-schema.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-schema/agstack-openagri-weather-service-validationerror-schema.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-schema/agstack-openagri-weather-service-httpvalidationerror-schema.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-schema/agstack-openagri-weather-service-body-token-auth-token-post-schema.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-structure/agstack-openagri-weather-service-predictionout-structure.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-structure/agstack-openagri-weather-service-weatherdataout-structure.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-structure/agstack-openagri-weather-service-thidataout-structure.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-structure/agstack-openagri-weather-service-sprayforecastresponse-structure.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-structure/agstack-openagri-weather-service-flightstatusforecastresponse-structure.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-structure/agstack-openagri-weather-service-geojsonout-structure.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-structure/agstack-openagri-weather-service-jsonldgraph-structure.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-structure/agstack-openagri-weather-service-authtoken-structure.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-structure/agstack-openagri-weather-service-pointout-structure.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-structure/agstack-openagri-weather-service-validationerror-structure.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-structure/agstack-openagri-weather-service-httpvalidationerror-structure.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-structure/agstack-openagri-weather-service-body-token-auth-token-post-structure.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-schema/agstack-asset-registry-registerfieldwktrequest-schema.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-schema/agstack-asset-registry-geojsonfeaturecollection-schema.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-schema/agstack-asset-registry-bulkpointresult-schema.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-structure/agstack-asset-registry-registerfieldwktrequest-structure.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-structure/agstack-asset-registry-geojsonfeaturecollection-structure.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/json-structure/agstack-asset-registry-bulkpointresult-structure.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/examples/agstack-openagri-weather-service-predictionout-example.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/examples/agstack-openagri-weather-service-weatherdataout-example.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/examples/agstack-openagri-weather-service-thidataout-example.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/examples/agstack-openagri-weather-service-sprayforecastresponse-example.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/examples/agstack-openagri-weather-service-flightstatusforecastresponse-example.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/examples/agstack-openagri-weather-service-geojsonout-example.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/examples/agstack-openagri-weather-service-jsonldgraph-example.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/examples/agstack-openagri-weather-service-authtoken-example.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/examples/agstack-openagri-weather-service-pointout-example.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/examples/agstack-openagri-weather-service-validationerror-example.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/examples/agstack-openagri-weather-service-httpvalidationerror-example.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/examples/agstack-openagri-weather-service-body-token-auth-token-post-example.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/examples/agstack-asset-registry-registerfieldwktrequest-example.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/examples/agstack-asset-registry-geojsonfeaturecollection-example.json

https://raw.githubusercontent.com/api-evangelist/agstack/refs/heads/main/examples/agstack-asset-registry-bulkpointresult-example.json

OpenAPI Specification

openapi: 3.0.3
info:
  title: AgStack Asset Registry api Field Retrieval & Queries API
  version: 1.0.0
  description: 'Welcome to the **AgStack Asset Registry** developer portal.


    ---


    ## 🔐 Authentication Guide


    | Service Zone | HTTP Method | Credential Type |

    | :--- | :---: | :--- |

    | **Authentication** | `GET/POST` | **Bearer Token** (where applicable) |

    | **Field Registration** | `POST` | **Bearer Token** |

    | **Field Retrieval** | `GET/POST`| **Bearer Token** (where applicable) |



    > 🚀 **Quick Start Guide**

    > 1. Login via `/login` to get an `access_token` and `refresh_token`.

    > 2. Use `Bearer_Token` (Lock Icon) to authorize protected routes.

    '
servers:
- url: https://api-ar.agstack.org
  description: Production Server
tags:
- name: Field Retrieval & Queries
paths:
  /fetch-field/{geo_id}:
    get:
      tags:
      - Field Retrieval & Queries
      summary: 🗺️ Fetch Field Data
      parameters:
      - name: geo_id
        in: path
        required: true
        schema:
          type: string
      - name: s2_index
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Field fetched successfully
        '400':
          $ref: '#/components/responses/ErrorResponse'
        '404':
          description: Field not found
  /fetch-field-wkt/{geo_id}:
    get:
      tags:
      - Field Retrieval & Queries
      summary: 📐 Fetch Field WKT
      parameters:
      - name: geo_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: WKT fetched successfully
        '400':
          $ref: '#/components/responses/ErrorResponse'
  /fetch-field-centroid/{geo_id}:
    get:
      tags:
      - Field Retrieval & Queries
      summary: 📌 Fetch Field Centroid
      parameters:
      - name: geo_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Centroid fetched successfully
        '400':
          $ref: '#/components/responses/ErrorResponse'
  /get-percentage-overlap-two-fields:
    post:
      tags:
      - Field Retrieval & Queries
      summary: 📊 Get Percentage Overlap
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - geo_id_field_1
              - geo_id_field_2
              properties:
                geo_id_field_1:
                  type: string
                geo_id_field_2:
                  type: string
      responses:
        '200':
          description: Overlap percentage calculated
        '400':
          $ref: '#/components/responses/ErrorResponse'
        '404':
          description: Field not found
components:
  responses:
    ErrorResponse:
      description: Generic Error Response
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Error description
              error:
                type: string
                example: Detailed exception message
  securitySchemes:
    Bearer_Token:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: '**Required for most operations.**

        1. Login via `/login` to get token.

        2. Paste access token here.

        '