Getting Started with Amini Lite
Amini Lite simplifies access to these datasets, without the need of knowledge on using geospatial tools, making it easy for data analysts, developers and businesses to derive insights from environmental data.
Access Amini lite in two ways:
- UI Frontend: This is a simple to use UI that enables you to generate data either by uploading their regions of interest or by drawing their region of interest on the provided maps. But first you need credits to be able to download the data.
- API: The API endpoint allows you to pull data from the Amini Data Catalog. Please note that you will need to add credits to your account before you can use the API endpoints.
Getting Started with UI Frontend
Step 1: Go to lite.amini.ai to get started by creating an account and adding credits to your balance.
Step 2: Go to ‘Settings’ on the top navigation bar.
Step 3: Click on ‘Purchase credits’.
Step 4: Add your desired amount.
Step 5: Enter your payment information.
Step 6: Check your updated balance.
Step 7: Go back to the ‘Overview’ page to check your balance. Once credits have been used, you can check this page to see how much you’ve spent on API requests or data download. You can also check any remaining credits.
Once you have credits loaded head to the download center to download the data.
Getting Started with Amini Lite Download Center
Step 1: Go to the Download Center, and then choose either a file to upload your geopolygons or you can draw your region of interest
Step 2: Check if the file preview shows the file you were expecting to upload.
— If your uploaded file includes a start and end date for the query, then the next screen goes straight to the parameter selection.
— If your uploaded file only contains geopolygons, then you’ll be prompted to select the start and end dates for your query.
— Incase you decide to draw a geopolygon, click next to select the timeframe data should be computed
Step 3: Select the indices (or parameters) you want to download for the data you uploaded or the polygons drawn.
Step 4: Check the dataset preview and ensure that you have sufficient balance on your wallet for the computation cost of the dataset you’re downloading.
Step 5: The job will be submitted to Amini Lite platform. You can click ‘Check Status’ to check the completion rate.
Step 6: Click on ‘Download CSV’ to download your requested dataset.
Getting Started with the API endpoint
Please note that you will need to add credits to your account before you can use the API endpoints.
Step 1: Go to the Amini Lite API Key page to generate your API key.
Step 2: Generate an API Key.
Step 3: This gives you an API Key that you need to note of and copy somewhere safe. Copy the API Key you just generated.
You won’t have the ability to copy the same API Key in the future, so make sure to store this somewhere you can access for future uses.
To use the API, you must include a valid API key with each request. If you don’t, you’ll get an error message.
There are two ways to add your API key:
- In the URL: Add it after a question mark (?).
- In the header: Add a valid API key with each request using X-API-Key
Request Header
Query Parameter
curl -X 'GET' \
'https://api.prd.amini.ai/public/api/v1/polygons' \
-H 'accept: application/json' \
-H 'x-api-key: INSERT_YOUR_API_KEY_HERE'
Replace INSERT_YOUR_API_KEY_HERE with your API key.
