Post List by Nearby
- Endpoint Path:
/api/fresns/v1/post/nearby - Method:
GET - Request:
Query
Headers Optional Parameter
| Key | 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
| Key | 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 |
| langTag | String | optional | Filter content by lang |
| contentType | String | optional | Filter content by type |
| filterType | String | optional | whitelist only returns key-value pairs for the given key namesblacklist removes specified key-value pairs from the returned data |
| filterKeys | String | optional | Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays |
| filterGroupType | String | optional | whitelist only returns key-value pairs for the given key namesblacklist removes specified key-value pairs from the returned dataApplies only to the group parameter in the returned result |
| filterGroupKeys | String | optional | Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays |
| filterHashtagType | String | optional | whitelist only returns key-value pairs for the given key namesblacklist removes specified key-value pairs from the returned dataApplies only to the hashtags parameter in the returned result |
| filterHashtagKeys | String | optional | Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays |
| filterGeotagType | String | optional | whitelist only returns key-value pairs for the given key namesblacklist removes specified key-value pairs from the returned dataApplies only to the geotag parameter in the returned result |
| filterGeotagKeys | String | optional | Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays |
| filterAuthorType | String | optional | whitelist only returns key-value pairs for the given key namesblacklist removes specified key-value pairs from the returned dataApplies only to the author parameter in the returned result |
| filterAuthorKeys | String | optional | Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays |
| filterQuotedPostType | String | optional | whitelist only returns key-value pairs for the given key namesblacklist removes specified key-value pairs from the returned dataApplies only to the quotedPost parameter in the returned result |
| filterQuotedPostKeys | String | optional | Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays |
| filterPreviewLikeUserType | String | optional | whitelist only returns key-value pairs for the given key namesblacklist removes specified key-value pairs from the returned dataApplies only to the previewLikeUsers parameter in the returned result |
| filterPreviewLikeUserKeys | String | optional | Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays |
| filterPreviewCommentType | String | optional | whitelist only returns key-value pairs for the given key namesblacklist removes specified key-value pairs from the returned dataApplies only to the previewComments parameter in the returned result |
| filterPreviewCommentKeys | String | optional | 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
}
]
}
}