Skip to content

Returns a list of baskets close to a given location.​

GET
/api/baskets/nearby

If no valid location is given, the user's home location is used. If the user has no home location, lat and lon paramters are required.
Baskets created by the current user are excluded.

Authorizations​

api_key

Requests manipulating data need to supply a CSRF token

Type
API Key (header: X-CSRF-Token)

Parameters​

Query Parameters

lat
Type
[ "number", "null" ]
Format
"float"
lon
Type
[ "number", "null" ]
Format
"float"
distance

Distance in kilometers.

Type
integer
Default
30
Maximum
50
Minimum
1

Responses​

Success

application/json
JSON
[
  
{
  
  
"id": 0,
  
  
"description": "string",
  
  
"picture": "string",
  
  
"until": "string",
  
  
"distanceInKm": 0,
  
  
"creator": {
  
  
  
"id": 342528,
  
  
  
"name": "Franzi",
  
  
  
"avatar": "99d1fb45-9748-3510-ac02-87b46c40048c",
  
  
  
"isSleeping": null
  
  
}
  
}
]

Playground​

Authorization
Variables
Key
Value

Samples​