areas.index
Resource information
URL | |
|---|---|
Method | GET |
Description | Returns a list of all available areas (continents and countries) |
Cache | 60 seconds |
Authorization required | No |
Method parameters
Name | Type | Description |
|---|---|---|
There are no method parameters in this resource | ||
Query parameters
Name | Type | Description |
|---|---|---|
lang | xsd:string | Determines language for the output data. The complete list of possible languages can be retrieved using the API resource: languages.index |
page | xsd:int | Determines offset of paginated data. Default value is 1 which means first page |
limit | xsd:int | Determines maximum number of returned records on page. Used in paginated data. Default value is 500. Possible values: 5, 10, 25, 50, 100, 250, 500 |
parent_area_id | xsd:int | Identifier which is parent to the selected area |
timestamp | xsd:unix_timestamp | Selection date, format UNIX_TIMESTAMP. Only changes that occurred or were updated after this timestamp will be returned |
Method calling examples
Link | Description |
|---|---|
Returns a list of all areas and sub-areas in JSON format | |
Returns a list of the areas which are sub-areas of area_id = 209 (Europe) |
Output elements
areas |
| ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
areas > area |
| ||||||||||
| |||||||||||