Search posts

v1.0.0

Searching posts takes the same arguments as listing posts except for the addition of the search and sort_by parameters. NOTE: When paging through the posts returned by this endpoint, there will be at most 1,000 posts that can be returned (eg. 50 pages worth of posts with the default per_page value of 20). In areas where there are more than 1,000 posts, clients can use more specific query parameters to adjust which posts are returned.

Input

{
  "type": "object",
  "properties": {
    "date_max": {
      "type": "string",
      "format": "date-time"
    },
    "date_min": {
      "type": "string",
      "format": "date-time"
    },
    "device_pixel_ratio": {
      "type": "number"
    },
    "group_ids": {
      "type": "string"
    },
    "include_reposts": {
      "type": "integer"
    },
    "latitude": {
      "type": "number"
    },
    "longitude": {
      "type": "number"
    },
    "outcomes": {
      "type": "string"
    },
    "page": {
      "type": "integer"
    },
    "per_page": {
      "type": "integer"
    },
    "radius": {
      "type": "number"
    },
    "search": {
      "type": "string"
    },
    "sort_by": {
      "type": "string"
    },
    "sources": {
      "type": "string"
    },
    "types": {
      "type": "string"
    },
    "user_state": {
      "type": "string"
    }
  },
  "required": [
    "search",
    "sources",
    "types"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "end_index": {
      "type": "integer",
      "description": "The index of the last post being returned (an integer between start_index and num_posts)."
    },
    "group_ids": {
      "type": "array",
      "description": "The IDs of the groups that the posts were retrieved from (will be null when no group IDs were used). These IDs may be a subset of the requested group IDs when a request includes group IDs for groups that are not open archives and that the current user is not a member of.  If the open_archive_groups source is used, these IDs may include the IDs of open archive groups that weren't present in the group_ids parameter of the request.\n",
      "items": {
        "type": "string"
      }
    },
    "num_pages": {
      "type": "integer",
      "description": "The total number of pages available."
    },
    "num_posts": {
      "type": "integer",
      "description": "The total number of posts available."
    },
    "page": {
      "type": "integer",
      "description": "The page number of the posts being returned."
    },
    "per_page": {
      "type": "integer",
      "description": "The number of posts being returned per page."
    },
    "posts": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "start_index": {
      "type": "integer",
      "description": "The index of the first post being returned (an integer between 1 and num_posts)."
    }
  }
}