# Eratos Platform Documentation

> Documentation for Eratos Platform

## Guides
- [Other Basic Data Queries](https://docs.eratos.com/docs/basic-queries.md)
- [Get 3D Subset as Array (Area over time)](https://docs.eratos.com/docs/get-3d-subset-as-array.md)
- [Under the hood: Get 3D Subset as Array](https://docs.eratos.com/docs/under-the-hood-get-3d-subset-as-array.md)
- [Get Geospatial Grid at a Time as Array](https://docs.eratos.com/docs/get-geospatial-grid-at-times-as-array.md)
- [Under the hood: Get Geospatial Grid at Times](https://docs.eratos.com/docs/under-the-hood-get-geospatial-grid-at-times.md)
- [Get Timeseries data at Points in Space](https://docs.eratos.com/docs/get-timeseries-at-points.md)
- [Under the hood: Get Timeseries at Points](https://docs.eratos.com/docs/under-the-hood-get-timeseries-at-points.md)
- [Data Access Methods](https://docs.eratos.com/docs/advanced-data-access-methods.md)
- [Searching the Eratos Semantic Web](https://docs.eratos.com/docs/searching-the-eratos-semantic-web.md)
- [Eratos Xarray Access Functions](https://docs.eratos.com/docs/xarray-access-function.md)
- [Eratos SDK Documentation](https://docs.eratos.com/docs/eratos-sdk.md)
- [Find Data in Marketplace](https://docs.eratos.com/docs/find-data-in-marketplace.md)
- [Eratos Development Key Recommended Practice](https://docs.eratos.com/docs/eratos-development-key-recommended-practice.md)
- [Create your Access Keys](https://docs.eratos.com/docs/generating-an-access-key.md)
- [Setup Local Environment](https://docs.eratos.com/docs/setup-local-environment.md): How to install and manage the Eratos SDK
- [Install the Eratos Data Toolkit](https://docs.eratos.com/docs/install-the-eratos-data-toolkit.md)
- [Upload, Download and Manage your Files in Eratos](https://docs.eratos.com/docs/upload-and-download-files-from-spaces.md): Guide to uploading, downloading and managing data in Eratos using the website.
- [Climate Sandboxes](https://docs.eratos.com/docs/climate-sandboxes.md)
- [Exploring Climate Datasets](https://docs.eratos.com/docs/exploring-climate-datasets.md)
- [Connecting PowerBI using Workspace API](https://docs.eratos.com/docs/connecting-powerbi-using-workspace-api.md): The following instructions provide details on how to connect and import data using the Eratos Workspace API to load and display in PowerBI.
- [Dashboard Creation Guide](https://docs.eratos.com/docs/dashboard-creation-guide.md)
- [Exporting and Sharing your Dashboard](https://docs.eratos.com/docs/exporting-and-sharing.md)
- [Viewer: IoT Data Dashboarding](https://docs.eratos.com/docs/eratos-viewer.md): How to set up and manage an Eratos Visualiser,  a real time way to readily access and view your IoT sensor information.
- [Map your Data](https://docs.eratos.com/docs/map-your-data.md): Use Kepler to create interactive data overlays
- [Plot Your Data](https://docs.eratos.com/docs/plot-your-data.md): Common approaches for plotting data
- [Gateway Node Guide](https://docs.eratos.com/docs/gateway-node-installation-guide.md): Version 2 - 10th July 2023
- [Eratos Sync](https://docs.eratos.com/docs/eratos-sync.md)
- [Uploading a Dataset to Eratos](https://docs.eratos.com/docs/uploading-a-dataset-to-eratos-getting-started.md)
- [Date-Time Data Standards](https://docs.eratos.com/docs/date-time-data-standards.md)
- [Definitions](https://docs.eratos.com/docs/definitions.md): Eratos Platform and Product Suite concepts
- [Standards and Definitions](https://docs.eratos.com/docs/eratos-data-standards.md)
- [Location Data Standards](https://docs.eratos.com/docs/location-data-standards.md)
- [Eratos Dataset Ontology](https://docs.eratos.com/docs/eratos-dataset-ontology.md)
- [Eratos Model Ontology](https://docs.eratos.com/docs/eratos-model-ontology.md)
- [Eratos Subscriptions](https://docs.eratos.com/docs/eratos-subscriptions.md)
- [Pricing](https://docs.eratos.com/docs/pricing.md): Links to live pricing information for Eratos Products
- [T&C's & Privacy Policies](https://docs.eratos.com/docs/tcs-privacy-policy.md): Use the links below to navigate to relevant Eratos User Legal Documentation
- [Metadata: The Eratos Semantic Web](https://docs.eratos.com/docs/the-eratos-semantic-web.md)
- [Does the Data Source service Queue/Buffer MQTT Messages?](https://docs.eratos.com/docs/data-source-service-mqtt-buffering.md)
- [Does Eratos Rate Limit API Requests?](https://docs.eratos.com/docs/does-eratos-rate-limit-api-requests.md)
- [Platform FAQs](https://docs.eratos.com/docs/faqs.md)
- [Getting started: Launch Pad](https://docs.eratos.com/docs/getting-started-with-eratos.md)
- [Navigation](https://docs.eratos.com/docs/navigation.md): Finding your way around our docs and the site as a whole.
- [Welcome to Eratos](https://docs.eratos.com/docs/welcome-to-eratos.md): _Eratosthenes is best known as the first person to calculate the circumference of the Earth, he was also the Chief Librarian at the Library of Alexandria.   We took the name Eratos to pay homage to these two facets of Eratosthenes’ life. We see ourselves as a library of data related to Planet Earth._
- [Onboarding Complete: Access Data](https://docs.eratos.com/docs/access-and-use-data-onboarding-complete.md)
- [Access and Use data: Getting Started](https://docs.eratos.com/docs/access-and-use-data.md)
- [Tutorials: What you can do on Eratos!](https://docs.eratos.com/docs/usecases.md)
- [Adding Sensors/IoT Devices to Eratos](https://docs.eratos.com/docs/iot-getting-started.md)
- [Run and Build Models on Eratos](https://docs.eratos.com/docs/run-and-build-models-on-eratos-getting-started.md)
- [Eratos Commercial Use License](https://docs.eratos.com/docs/eratos-commercial-license.md)
- [Eratos Research Use License](https://docs.eratos.com/docs/eratos-research-licence.md)
- [Marketplace Licenses](https://docs.eratos.com/docs/licences.md)
- [Analysis Service Model Developer's Guide: Python Models](https://docs.eratos.com/docs/analysis-service-model-developers-guide-python-models.md)
- [Analysis Service Model Developer's Guide: R Models](https://docs.eratos.com/docs/analysis-service-model-developers-guide-r-models.md)
- [Analysis Service Model Developer's Guide](https://docs.eratos.com/docs/create-a-senaps-model.md)
- [How to Build an Eratos Model](https://docs.eratos.com/docs/how-to-build-an-eratos-model.md)
- [How to Publish your Model](https://docs.eratos.com/docs/how-to-publish-a-model.md)
- [Build a Model](https://docs.eratos.com/docs/build-a-model.md)
- [Suplementary resources](https://docs.eratos.com/docs/suplementary-resources.md)
- [Run a Model on Eratos](https://docs.eratos.com/docs/run-a-model.md)
- [Eratos Platform v1.2](https://docs.eratos.com/docs/eratos-platform-12.md): Integration with Grafana - 21 October 2022
- [Eratos Platform v1.1](https://docs.eratos.com/docs/eratos-platform-v11-sep-2022.md): Release of Spaces Enhancements and Studio v1 - 12 September
- [Eratos Platform v1.14](https://docs.eratos.com/docs/eratos-platform-v113-copy.md): Release Date: 24 May 2023
- [Eratos Platform v1.13](https://docs.eratos.com/docs/eratos-platform-v113.md): Release Date: 12 May 2023
- [Eratos Platform v1.3](https://docs.eratos.com/docs/eratos-platform-v12.md): Release of Payment Gateway and minor frontend enhancements
- [Eratos Platform v1.10](https://docs.eratos.com/docs/eratos-platform-v120.md): Release Date: 16 Mar 2023
- [Eratos Platform v1.11](https://docs.eratos.com/docs/eratos-platform-v121.md): Release Date: 22 Mar 2023
- [Eratos Platform v1.12](https://docs.eratos.com/docs/eratos-platform-v122.md): Release Date: 30 Mar 2023
- [Eratos Platform v1.4](https://docs.eratos.com/docs/eratos-platform-v14.md): Updates to User Account section - 8 Dec 2022
- [Eratos Platform v1.5](https://docs.eratos.com/docs/eratos-platform-v15.md): Release Date: 22 Dec 2022
- [Eratos Platform v1.6](https://docs.eratos.com/docs/eratos-platform-v16.md): Release Date: 18 Jan 2023
- [Eratos Platform v1.7](https://docs.eratos.com/docs/eratos-platform-v17.md): Release Date: 23 Jan 2023
- [Eratos Platform v1.8](https://docs.eratos.com/docs/eratos-platform-v18.md): Release Date: 2 Feb 2023
- [Eratos Platform v1.9](https://docs.eratos.com/docs/eratos-platform-v19.md): Release Date: 9 Mar 2023
- [Eratos platform v1.0](https://docs.eratos.com/docs/eratos-platform-version-1.md): Current functionality on the Eratos platform as at 10 August 2022
- [Sensor Communication Protocols](https://docs.eratos.com/docs/communication-protocols.md)
- [CSV Message Parser](https://docs.eratos.com/docs/csv-parser.md)
- [Hussat Message Parser](https://docs.eratos.com/docs/hussat-message-parser.md)
- [JSON Message Parser](https://docs.eratos.com/docs/json-message-parser.md)
- [API Based Sensor Data Sources](https://docs.eratos.com/docs/https-sensor-setup.md)
- [Connecting your Sensors to Senaps](https://docs.eratos.com/docs/before-you-connect-to-senaps-copy.md)
- [Sending data to a Data Source (Senaps JSON Msg API)](https://docs.eratos.com/docs/sending-data-to-a-datasource.md)
- [Data Sources: Create and Manage](https://docs.eratos.com/docs/setup-a-sensor-in-senaps-copy.md)
- [Connect IoT using Senaps API](https://docs.eratos.com/docs/connect-iot-in-a-development-environment.md)
- [Data Stream Data Types](https://docs.eratos.com/docs/datastream-data-types.md): Overview of available data types stored in a datastream
- [Creating Datastreams](https://docs.eratos.com/docs/data-streams-creating-and-managing.md)
- [Create Metadata for your Sensor Fleet](https://docs.eratos.com/docs/create-metadata-for-your-sensor-fleet.md): Define the meta data structures to help you manage your sensor fleet.
- [Manage, Access and Visualise your Sensor Fleet](https://docs.eratos.com/docs/manage-your-sensor-fleet.md)
- [Push Data Stream Back to Senaps](https://docs.eratos.com/docs/push-data-stream-back-to-senaps.md)
- [Query Sensor Data Out of Senaps](https://docs.eratos.com/docs/query-sensor-data-out-of-senaps.md)
- [Eratos Sidecar: Get Started](https://docs.eratos.com/docs/get-started-with-eratos-sidecar.md)
- [Installing Dependencies in RStudio](https://docs.eratos.com/docs/installing-dependencies-in-rstudio.md)
- [Sidecar pricing](https://docs.eratos.com/docs/sidecar-pricing.md)
- [Take Sidecar for a spin](https://docs.eratos.com/docs/take-sidecar-for-a-spin.md)
- [Common Errors and issues](https://docs.eratos.com/docs/common-errors-and-issues.md): A list of common errors, known issues and their fixes
- [Contact Support](https://docs.eratos.com/docs/contact-support.md): Welcome to the Eratos Support Team.  We look forward to working with you as you explore and innovate on our platform.
- [Eratos Learn Videos](https://docs.eratos.com/docs/eratos-learn-videos.md)
- [Troubleshooting Start Here](https://docs.eratos.com/docs/troubleshooting-start-here.md)

## API Reference
- [Analysis Service API](https://docs.eratos.com/reference/analysis-service-api.md)
- [Model Developer's Guide](https://docs.eratos.com/reference/model-developers-guide.md)
- [Model Developer's Guide: Python Models](https://docs.eratos.com/reference/model-developers-guide-python-models.md)
- [Model Developer's Guide: R Models](https://docs.eratos.com/reference/model-developers-guide-r-models.md)
- [Get all Dataparsers](https://docs.eratos.com/reference/getdataparser.md): Get all Dataparsers in your security scope as a list, optionally filtered
- [Get a Dataparser by ID](https://docs.eratos.com/reference/getdataparserwithid.md): Get a Dataparser by ID. Must be accessible via your security scope.
- [Delete by ID](https://docs.eratos.com/reference/deletedatasourcewithid.md): Delete the specified Datasource
- [Get all datasources](https://docs.eratos.com/reference/getdatasource.md): Get all datasources in your security scope as a list, optionally filtered
- [Get datasource by id](https://docs.eratos.com/reference/getdatasourcewithid.md): Get a record for the specified datasource
- [Get the list of valid metrics for this datasource](https://docs.eratos.com/reference/getdatasourcewithidlivemetrics.md): Get the list of valid metrics
- [Get metric for datasource](https://docs.eratos.com/reference/getdatasourcewithidlivemetricswithmetric.md): Get a named metric for the specified datasource
- [Create a Datasource](https://docs.eratos.com/reference/postdatasource.md): Create a new Datasource
- [Update a datasource](https://docs.eratos.com/reference/putdatasourcewithid.md): Changes the identified Datasource resource
- [Get all datasource logs](https://docs.eratos.com/reference/getdatasourcewithidlogs.md): Get all logs for the specified datasource, optionally filtered
- [Get a log entry by id](https://docs.eratos.com/reference/getdatasourcewithidlogswithmsgid.md): Get a log record by id
- [Get root API resource](https://docs.eratos.com/reference/get.md): Get root API resource
- [Delete Resource](https://docs.eratos.com/reference/delete_resource_resources__resourceid__delete.md): Delete a specific resource by ID or ERN.
- [Get Policy](https://docs.eratos.com/reference/get_policy_policies__policyid__get.md): Gets the policy from a given ern
- [Get Resource Policy](https://docs.eratos.com/reference/get_resource_policy_resources__resourceid__policy_get.md): Gets the provided policy from an existing resource.
- [Get Resource](https://docs.eratos.com/reference/get_resource_resources__resourceid__get.md): Get a specific resource by ID or ERN.
- [Get Resources](https://docs.eratos.com/reference/get_resources_resources_get.md): Find resources
- [Patch Resource](https://docs.eratos.com/reference/patch_resource_resources__resourceid__patch.md): Update a singular or multiple properties of an existing resource
- [Post Resource Action](https://docs.eratos.com/reference/post_resource_action_resources__resourceid__action_post.md): Perform an action on an existing resource.   See body params below for available actions.
- [Post Resource](https://docs.eratos.com/reference/post_resource_resources_post.md): Create resources.  See examples and schemas below for the types of resources.
- [Put Resource](https://docs.eratos.com/reference/put_resource_resources__resourceid__put.md): Update properties of an existing resource. If the resource does not exist, a new resource will be created
- [Download Dataset Files](https://docs.eratos.com/reference/download_dataset_files_download_get.md): Download a single file from an existing dataset resource.
- [Drill Dataset](https://docs.eratos.com/reference/drill_dataset_drill_get.md): Drill a gridded dataset at a given latitude and longitude along the time axis for a given variable or variables          - If no variables are provided, all variables in the dataset will be returned. To obtain a list of variables in the dataset, see the `/resources/:rid` endpoint. - Results are returned in natural order by default, however, the `direction` parameter can be used to reverse the order of the results - Limits and offsets can be used to paginate the results (default limit is 10 and max limit is 1000)          Constraints:  - Only resources of type `ern:e-pn.io:schema:block` or `ern:e-pn.io:schema:dataset` are supported and must offer a gridded interface. - The dataset resource must have a recognised time property to drill on. Supported property names are ['time'] - The dataset resource must have a recognised `latitude` and `longitude` property to drill on. Supported property names are ['lat', 'latitude', 'Latitude'] and ['lon', 'longitude', 'Longitude'] - The `start` date must be before the `end` date if both are provided and in ISO8601 format - The `latitude` must be between -90 and 90 degrees and the longitude must be between -180 and 180 degrees inclusive. - The `latitude` and `longitude` must be within the bounds of the dataset              Returns:  - A timeseries along the time axis for the given latitude and longitude with the requested variables          Example:              ``` GET /drill?resourceId=eratos.blocks.silo.maxtemperature&variable=max_temp&latitude=-37.8&longitude=144.95&start=2024-08-23&end=2024-08-24 ```
- [Subset Geospatial Dataset](https://docs.eratos.com/reference/subset_geospatial_dataset_subset_get.md): > 🧪 **Beta Feature**: The subset endpoint is currently in beta testing, the API query parameters and response formats are subject to change. If you have any feedback please contact us through our [support portal](https://eratos.atlassian.net/servicedesk/customer/portal/2).  Subset a gridded dataset within a bounding box of latitude and longitude coordinates along the time axis for a given variable or variables  - If no variables are provided, all variables in the dataset will be returned. To obtain a list of variables in the dataset, see the `/resources/:rid` endpoint. - Results are returned in natural order by default, however, the `direction` parameter can be used to reverse the order of the results - Limits and offsets can be used to paginate the results (default limit is 10 and max limit is 10000) - Results can be returned in different formats based on the Accept header (application/json, image/tiff, application/vnd.eratos.json)  Constraints:  - Only resources of type `ern:e-pn.io:schema:block` or `ern:e-pn.io:schema:dataset` are supported and must offer a gridded interface. - The dataset resource must have a recognised time property to subset on. Supported property names are ['time'] - The dataset resource must have recognised `latitude` and `longitude` properties to subset on. Supported property names are ['lat', 'latitude', 'Latitude'] and ['lon', 'longitude', 'Longitude'] - The `start` date must be before the `end` date if both are provided and in ISO8601 format - The bounding box coordinates must be within valid ranges: latitude between `-90` and `90` degrees, longitude between `-180` and `180` degrees - The bounding box must be specified in the order of `minLongitude,minLatitude,maxLongitude,maxLatitude` - Only 3-dimensional datasets are supported - The dimensional selection must not exceed 10000 cells - When requesting image/tiff format, only one variable can be specified  Returns:  - A spatiotemporal subset within the specified bounding box with the requested variables - Format depends on the Accept header   - JSON by default (application/json)   - JSON, no href links (application/vnd.eratos.json)   - GeoTIFF (image/tiff)  Example: Gets the last 10 results from the dataset from the given coordinates for `max_temp` ``` GET /subset?resourceId=eratos.blocks.silo.maxtemperature&bbox=144.95,-37.8,145.05,-37.7&variable=max_temp&limit=10&skip=0&direction=-1 ```
- [Upload Dataset](https://docs.eratos.com/reference/uploadfilerequest.md): Attach a file to an existing dataset resource.
- [Eratos Workspace API (v1)](https://docs.eratos.com/reference/eratos-workspace-api-v1.md): https://api.eratos.com/api/workspace/v1/
- [Read Root](https://docs.eratos.com/reference/read_root__get.md): Root endpoint.
- [Deletes a data file from Thredds](https://docs.eratos.com/reference/deletedatabyquery.md): Deletes a data file from Thredds.  The dataset to delete can be identified in one of two ways: either using the dataset's URL path, or using its ID. If identifying the dataset by its URL path, the ID of the organisation owning the dataset **must** be given as the first component of the `path` parameter, or via the `organisationid` parameter (but not both).  This operation differs from the `deleteDataByPath` operation only in how the `path` is passed: in this case, the `path` is passed as a query parameter.
- [Uploads a new data file to Thredds](https://docs.eratos.com/reference/postdata.md): Uploads a new data file to Thredds.  Files uploaded using this service are placed in an organisation-specific catalog, and their URL path is prefixed with the uploading organisation's ID. As a concrete example, if uploading a new data file to be owned by an organisation 'Acme' (e.g. `organisationid=acme`) and with `path=/some/directory/file.nc`, then the final URL path of the uploaded file will be `/acme/some/directory/file.nc`, and the details of the file will be found in an Acme-specific catalog that will be linked from the main Thredds catalog.
- [Replaces an existing data file in Thredds](https://docs.eratos.com/reference/putdata.md): Replaces an existing data file in Thredds.  Files uploaded using this service replace an existing dataset.The path is prefixed with the dataset's existing organisation id, similar to the POST `/data` operation. As a concrete example, if uploading a  data file owned by the organisation 'Acme' (e.g. `organisationid=acme`) and with `path=/some/directory/file.nc`, then the final URL path of the uploaded file will be `/acme/some/directory/file.nc`, and the details of the file will be found in an Acme-specific catalog that will be linked from the main Thredds catalog.
- [Deletes a data file from Thredds](https://docs.eratos.com/reference/deletedatabypath.md): Deletes a data file from Thredds.  The dataset to delete can be identified in one of two ways: either using the dataset's URL path, or using its ID. If identifying the dataset by its URL path, the ID of the organisation owning the dataset **must** be given as the first component of the `path` parameter, or via the `organisationid` parameter (but not both).  This operation differs from the `deleteDataByPath` operation only in how the `path` is passed: in this case, the `path` is appended to the request path.
- [Drill a timeseries from a gridded dataset hosted in THREDDS](https://docs.eratos.com/reference/getdrill.md)
- [Gets the root API resource](https://docs.eratos.com/reference/doget.md): Returns some metadata about the service. Useful for service introspection purposes, or as a target for authentication checks.

## Recipes
- [Assess Property Viability](https://docs.eratos.com/recipes/assess-property-viability.md)
- [Get rainfall data at a location for a specific time period](https://docs.eratos.com/recipes/get-rainfall-data-at-a-location-for-a-specific-time-period.md)