The API endpoint is the following:
https://goadmin.ifrc.org/api/v2/appeal/
| Variable code | Data Type | Accept Null Value | Description | Filtering available in API |
|---|---|---|---|---|
| aid | str | False | Unique identifier of the appeal provided by the Apple system | False |
| name | str | False | Name of the appeal. Usually has name and location of the disaster | True |
| dtype | dict | False | *Type of the disaster according to IFRC categories. | True |
| atype | int | False | Type of appeal. 0: DREF, 1: Emergency Appeal, 2: International appeal | True |
| atype_display | str | False | Type of appeal (str) | False |
| status | int | False | Status of appeal. 0: Active, 1:Closed, 2: Frozen, 3: Archived | True |
| status_display | str | False | Status of appeal (str) | False |
| code | str | False | Appeal alphanumeric code | True |
| sector | str | False | Region, country cluster or country office that submits the appeal, e.g. South America country cluster | False |
| num_beneficiaries | int | True | **Number of beneficiaries from appeal resources | False |
| amount_requested | int | False | Amount requested in appeal in CHF | False |
| amount_funded | int | True | Amount funded in CHF. This amount is nullable as when emergency appeals are launched | False |
| start_date | str | False | Start date of appeal in UTC time. Format: YYYY-MM_DDT00:00:00Z | True |
| end_date | str | False | End date of appeal in UTC time. Format: YYYY-MM_DDT00:00:00Z | True |
| created_at | str | False | ‡Creation date of appeal in GO in UTC time. Format: YYYY-MM_DDT00:00:00Z | False |
| modified_at | str | False | ‡‡Modification date of appeal in GO in UTC time. Format: YYYY-MM_DDT00:00:00Z | False |
| event | int | True | ‡‡‡GO event ID | False |
| needs_confirmation | bool | False | Does the event related to the appeal needs confirmation. | False |
| country | dict | False | Country related to the country cluster that submitted the appeal. It contains the main information about the country (e.g. iso3, name, society name, region) | True |
| region | dict | False | Region responsible for the appeal. | True |
| id | int | False | Unique ID for the appeal in GO | True |
aid: You can filter the table through a general search (besides to the name field, the search would be done in the code field) e.g.: https://goadmin.ifrc.org/api/v2/appeal/?search=Vanuatu%20Volcanoname: Need to provide the code of the type of the disaster e.g. for Food Insecurity: https://goadmin.ifrc.org/api/v2/appeal/?dtype=21. The relation between disaster type's 'name' and 'id' can be found here: https://goadmin.ifrc.org/api/v2/disaster_type/dtype: Need to provide the code of the type of appeal e.g. for DREF: https://goadmin.ifrc.org/api/v2/appeal/?atype=0status: Need to provide the code of the status of appeal e.g. for Active: https://goadmin.ifrc.org/api/v2/appeal/?status=0code: Need to provide the Appeal ID code e.g.https://goadmin.ifrc.org/api/v2/appeal/?code=MDRZA011 . Or you can filter the table through a general search (besides to the code field, the search would be done in the name field) e.g.: https://goadmin.ifrc.org/api/v2/appeal/?search=MDRZA011start_date: Need to provide the start date in specified format e.g.: https://goadmin.ifrc.org/api/v2/appeal/?start_date__gte=2021-11-10T00%3A00%3A00end_date: Need to provide the start date in specified format e.g.: https://goadmin.ifrc.org/api/v2/appeal/?end_date__lte=2021-11-10T00%3A00%3A00country: Need to provide the GO country ID, e.g. https://goadmin.ifrc.org/api/v2/appeal/?country=121. The relation between country's 'name' and 'id' can be found here: https://goadmin.ifrc.org/api/v2/countryregion: Need to provide the GO region ID, e.g. https://goadmin.ifrc.org/api/v2/appeal/?region=2. The relation between 'region_name' and 'id' can be found here: https://goadmin.ifrc.org/api/v2/regionid: Need to provide the GO appeal ID, e.g. https://goadmin.ifrc.org/api/v2/appeal/?appeal_id=3507*There are 22 different categories, each appeal is related to one type of category (e.g.: Epidemic, Flood, Complex Emergency).
** This amount is nullable, as this number cannot be always be estimated at the beginning of an operation. Null values are represented as 0.
‡ The appeal creation comes from a synchronization with the Apple system. This variable is related with the date when the synchronization happened. Most of the times the created_at date is larger than the start_date.
‡‡ The appeal creation comes from a synchronization with the Apple system. This variable is related with the date when the synchronization happened. Most of the times the modified_date date is larger than the created_at date.
‡‡‡ Not all the appeals have a related event (emergency), as the matching between appeal and event is a semi automatic process. Null values are represented as NaN.