Post List by Nearby
- Endpoint Path:
/api/v2/post/nearby
- Method:
GET
- Request:
Query
Headers Optional Parameter
Parameter Name | Public Mode (Required) | Private Mode (Required) |
---|---|---|
X-Fresns-Aid | optional | required |
X-Fresns-Aid-Token | optional | required |
X-Fresns-Uid | optional | required |
X-Fresns-Uid-Token | optional | required |
Body Params
Parameter Name | Type | Required | Description |
---|---|---|---|
mapId | Number | required | Map Service Provider |
mapLng | String | required | Map Longitude |
mapLat | String | required | Map Latitude |
unit | String | optional | Range unit km or mi |
length | Number | optional | Range length |
contentType | String | optional | Filter content by type |
pluginRatingId | Number | optional | Sort number (plug-in specific) |
whitelistKeys | String | optional | Whitelist key names, only returns key-value pairs for the given key names Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays |
blacklistKeys | String | optional | Blacklist key names, removes specified key-value pairs from the returned data Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays |
pageSize | Number | optional | Number of items per page (default 30 items) |
page | Number | optional | Page number (default 1) |
Return
json
{
"code": 0,
"message": "ok",
"data": {
"pagination": {
"total": "Number / How much data in total",
"current": "Number / Current page number",
"pageSize": "Number / How much data on each page",
"lastPage": "Number / Last page number"
},
"list": [
{
// Common Data Structure -> Post Info
}
]
}
}