API For isitgettinghotorisitjust.me
Introduction
What does your API do?
Overview
Things that the developers should know about
Authentication
What is the preferred way of using the API?
Error Codes
What errors and status codes can a user expect?
Rate limit
Is there a limit to the number of requests an user can send?
GETGet Data about Countries
Given a query that is a list composed of ISO 3166 Alpha 3 Country Codes, country names or integers does the following for each element of the query list:
- If the element is a string then finds the corresponding country with code or name and adds it to the result.
- If the element is an integer then it applies the given filter, search parameters and sorts them and returns the instance that is on the position denoted by element.
Parameters:
- query: list composed of ISO 3166 Alpha 3 Country Codes, country names or integers
- sort: attribute name that the instances will be sorted with(available values: country_code, country_name, EPI)
- order: sorting order can be either "asc" or "desc"
- keywords: list of strings that should exist in the instance
- other params are used for filtering and they correspond to a list of two values denoting the range we should filter on i.e EPI=[80,100] will filter out any countries except with those who have an epi score between 80 and 100.(available params: country_name, EPI, longitude, latitude)
The return object will look like this:
And each elements of results will look like this:
Returns 200 if successful, 400 if the query parameter is absent or ill formed.
GETGet Data about Issues
Given a query that is a list composed of Issue names or integers does the following for each element of the query list:
- If the element is a string then finds the corresponding issue with name and adds it to the result.
- If the element is an integer then it applies the given filter, search parameters and sorts them and returns the instance that is on the position denoted by element.
Parameters:
- query: list composed of issue names or integers
- sort: attribute name that the instances will be sorted with(available values: issue_name, country(sorts by country count), charity(sorts by charity count))
- order: sorting order can be either "asc" or "desc"
- keywords: list of strings that should exist in the instance
- other params are used for filtering and they correspond to a list of two values denoting the range we should filter on i.e issue_name=["Ecocide","Environmental crime"] will filter out any issues with names that aren't between Ecocide and Environmental Crime.
The return object will look like this:
And each elements of results will look like this:
Returns 200 if successful, 400 if the query parameter is absent or ill formed.
GETGet Data about Charities
Given a query that is a list composed of charity names or integers does the following for each element of the query list:
- If the element is a string then finds the corresponding issue with name and adds it to the result.
- If the element is an integer then it applies the given filter, search parameters and sorts them and returns the instance that is on the position denoted by element.
Parameters:
- query: list composed of charity names or integers
- sort: attribute name that the instances will be sorted with(available values: charity_name, country(sorts by country count), issue(sorts by issue count))
- order: sorting order can be either "asc" or "desc"
- keywords: list of strings that should exist in the instance
- other params are used for filtering and they correspond to a list of two values denoting the range we should filter on i.e charity_name=["Boston Harbor Now","Connecticut Fund for the Environment"] will filter out any charities with names that aren't between Boston Harbor Now and Connecticut Fund for the Environment.
The return object will look like this:
And each elements of results will look like this:
Returns 200 if successful, 400 if the query parameter is absent or ill formed.