Skip to content

Post List by Nearby

  • Endpoint Path: /api/fresns/v1/post/nearby
  • Method: GET
  • Request: Query

Headers Optional Parameter

KeyPublic Mode (Required)Private Mode (Required)
X-Fresns-Aidoptionalrequired
X-Fresns-Aid-Tokenoptionalrequired
X-Fresns-Uidoptionalrequired
X-Fresns-Uid-Tokenoptionalrequired

Body Params

KeyTypeRequiredDescription
mapIdNumberrequiredMap Service Provider
mapLngStringrequiredMap Longitude
mapLatStringrequiredMap Latitude
unitStringoptionalRange unit km or mi
lengthNumberoptionalRange length
langTagStringoptionalFilter content by lang
contentTypeStringoptionalFilter content by type
filterTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
filterKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterGroupTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the group parameter in the returned result
filterGroupKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterHashtagTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the hashtags parameter in the returned result
filterHashtagKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterGeotagTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the geotag parameter in the returned result
filterGeotagKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterAuthorTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the author parameter in the returned result
filterAuthorKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterQuotedPostTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the quotedPost parameter in the returned result
filterQuotedPostKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterPreviewLikeUserTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the previewLikeUsers parameter in the returned result
filterPreviewLikeUserKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
filterPreviewCommentTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
Applies only to the previewComments parameter in the returned result
filterPreviewCommentKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays
pageSizeNumberoptionalNumber of items per page (default 30 items)
pageNumberoptionalPage 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
            }
        ]
    }
}

Released under the Apache-2.0 License