GET
/api/places
Returns the list of the places
Request
CORS: Publicly Accessible
Query params | ||
limit | uint | |
offset | uint | |
positions | array | Filter places in specific positions maxItems: 1000 |
positions[] | string | |
only_favorites | boolean | True if shows only favorite places |
only_highlighted | boolean | True if shows only highlighted places |
order_by | "like_score" "most_active" "updated_at" "created_at" string | Order places by |
order | "asc" "desc" string | List order default: "desc" |
with_realms_detail | boolean | Add the numbers of users in each Realm (experimental) |
search | string | Filter places that contains a text expression, should have at least 3 characters otherwise the resultant list will be empty |
categories | array | Filter places by available categories |
categories[] | string | |
Response
Body | ||
ok | boolean | Define where the request was completed |
data | array | |
data[] | object | |
data[].id | uudi | place id |
data[].title | string | The place name minLength: 0 maxLength: 50 |
data[].description | string | The place description minLength: 0 maxLength: 5000 |
data[].image | uri | Url to the place cover or image |
data[].owner | string | The owner's name minLength: 0 maxLength: 42 |
data[].positions | array | A list of positions of the place |
data[].positions[] | string | |
data[].base_position | string | The base position of the place |
data[].contact_name | string | The contact name of the place minLength: 0 maxLength: 5000 |
data[].contact_email | string | The contact email on the place minLength: 0 maxLength: 5000 |
data[].content_rating | string | The content rating on the place minLength: 0 maxLength: 1 |
data[].likes | number | The number of likes on the place minimum: 0 |
data[].dislikes | number | The number of dislikes on the place minimum: 0 |
data[].like_score | number | A calculated number to qualify a place based on its likes and dislikes only taking into account the users with enough VP default: null minimum: 0 maximum: 1 |
data[].like_rate | number | The percentage of likes on the place expressed on decimal fraction default: null minimum: 0 maximum: 1 |
data[].favorites | number | The number of favorites on the place minimum: 0 |
data[].disabled | boolean | True if the place is disabled |
data[].disabled_at | date-time | The date when the place was disabled |
data[].created_at | date-time | the time the place was created |
data[].updated_at | date-time | The time the place was last updated |
data[].deployed_at | date-time | The time the place was last deployed |
data[].user_like | boolean | True if user likes the place |
data[].user_dislike | boolean | True if user dislikes the place |
data[].user_favorite | boolean | True if user seletect as favorite the place |
data[].user_count | number | The number of users in the place minimum: 0 |
data[].realms_detail | array | A list of realms with users in each Realm (experimental) |
data[].realms_detail[] | object | |
data[].realms_detail[].serverName | string | The name of the Realm server |
data[].realms_detail[].url | string | The url of the Realm |
data[].realms_detail[].usersCount | number | The total amount of users of the Realm |
data[].realms_detail[].userParcels | array | Array of parcels for users of the Realm |
data[].realms_detail[].userParcels[] | array | X and Y of the parcel minItems: 2 maxItems: 2 |
data[].realms_detail[].userParcels[][] | number | |
data[].user_visits | number | The number of users that had visited the place in the last 30 days minimum: 0 |
data[].categories | array | A list of the Place's categories |
data[].categories[] | string | |