Search

Search All

Description

This endpoint performs a comprehensive search across Facebook, allowing you to search for various types of content including posts, pages, groups, and more based on the provided query.

Endpoint

POST api/v1/realtime/social/facebook/v1/search/all

Parameters

Param
Required
Param Type
Description

typed_query

Yes

Body Param

String | The search query string used to find matching content across Facebook.

end_cursor

No

Body Param

String | The cursor to paginate

disable_blocks

No

Body Param

Boolean | This parameter allows you to decide the data structure of the response from Facebook, whether to return data in Bloks or JSON form. Bloks is a proprietary format of Facebook, so we suggest setting this parameter to true

Example Request
curl -X POST 'https://api.webit.live/api/v1/realtime/social/facebook/v1/search/all' \
--header 'Authorization: Basic <credential string>' \ 
--data '{
    "typed_query": "olympics2024"
}'
Example Response
{
    "data": {
        "search_query": {
            "cache_id": "2344920769953646283",
            "query_function": "keywords_search(olympics2024)",
            "logging_unit_id": "browse_serp:3eab094d-1527-4fd9-a8db-4f01acfd146c",
            "combined_results": {
                "page_info": {...},
                "has_hcm": false,
                "degradation_level": null,
                "has_iem_triggered": false,
                "is_cache_hit": null,
                "edges": [...],
                "speller_confidence": "NONE",
                "speller_nt_view": null,
                "corrected_query": null
            },
            "filter_type_sets": [
                {
                    "filters": [
                        {
                            "main_filter": null,
                            "filter_shortcut": "POSTS"
                        },
                        ...
                    ]
                }
            ]
        }
    }
}

Search Posts

Description

This endpoint allows you to search for posts across Facebook that match the provided query. It retrieves posts that contain the specified search term.

Endpoint

POST api/v1/realtime/social/facebook/v1/search/posts

Parameters

Param
Required
Param Type
Description

typed_query

Yes

Body Param

String | The search query string used to find matching content across Facebook.

end_cursor

No

Body Param

String | The cursor to paginate

disable_blocks

No

Body Param

Boolean | This parameter allows you to decide the data structure of the response from Facebook, whether to return data in Bloks or JSON form. Bloks is a proprietary format of Facebook, so we suggest setting this parameter to true

start_date

No

Body Param

String | ISO date of the start date to use as a filter

end_date

No

Body Param

String | ISO date of the end date to use as a filter

public_posts

No

Body Param

Boolean | set true to add a public posts filter (search public posts).

city_id

No

Body Param

String | tagged location filter - use search filters endpoint with city filter type to get this value

recent_post

No

Body Param

Boolean | set true add a recent posts search filter

Example Request
Example Response

Search Events

Description

This endpoint allows you to search for events on Facebook that match the provided query. It retrieves events that contain the specified search term.

Endpoint

POST api/v1/realtime/social/facebook/v1/search/events

Parameters

Param
Required
Param Type
Description

typed_query

Yes

Body Param

String | The search query string used to find matching content across Facebook.

end_cursor

No

Body Param

String | The cursor to paginate

disable_blocks

No

Body Param

Boolean | This parameter allows you to decide the data structure of the response from Facebook, whether to return data in Bloks or JSON form. Bloks is a proprietary format of Facebook, so we suggest setting this parameter to true

start_date

No

Body Param

String | ISO date of the start date to use as a filter

end_date

No

Body Param

String | ISO date of the end date to use as a filter

city_id

No

Body Param

String | tagged location filter - use search filters endpoint with city filter type to get this value

Example Request
Example Response

Search Photos

Description

This endpoint allows you to search for photos on Facebook that match the provided query. It retrieves photos that contain the specified search term.

Endpoint

POST api/v1/realtime/social/facebook/v1/search/photos

Parameters

Param
Required
Param Type
Description

typed_query

Yes

Body Param

String | The search query string used to find matching content across Facebook.

end_cursor

No

Body Param

String | The cursor to paginate

disable_blocks

No

Body Param

Boolean | This parameter allows you to decide the data structure of the response from Facebook, whether to return data in Bloks or JSON form. Bloks is a proprietary format of Facebook, so we suggest setting this parameter to true

start_date

No

Body Param

String | ISO date of the start date to use as a filter

end_date

No

Body Param

String | ISO date of the end date to use as a filter

Example Request
Example Response

Search Videos

Description

This endpoint allows you to search for videos across Facebook based on the provided query. It retrieves videos that match the specified search term.

Endpoint

POST api/v1/realtime/social/facebook/v1/search/videos

Parameters

Param
Required
Param Type
Description

typed_query

Yes

Body Param

String | The search query string used to find matching content across Facebook.

end_cursor

No

Body Param

String | The cursor to paginate

disable_blocks

No

Body Param

Boolean | This parameter allows you to decide the data structure of the response from Facebook, whether to return data in Bloks or JSON form. Bloks is a proprietary format of Facebook, so we suggest setting this parameter to true

start_date

No

Body Param

String | ISO date of the start date to use as a filter

end_date

No

Body Param

String | ISO date of the end date to use as a filter

live_video

No

Body Param

Boolean | set true to add a live video filter

Example Request
Example Response

Search Users

Description

This endpoint allows you to search for users on Facebook that match the provided query. It retrieves user profiles that contain the specified search term.

Endpoint

POST api/v1/realtime/social/facebook/v1/search/users

Parameters

Param
Required
Param Type
Description

typed_query

Yes

Body Param

String | The search query string used to find matching content across Facebook.

end_cursor

No

Body Param

String | The cursor to paginate

disable_blocks

No

Body Param

Boolean | This parameter allows you to decide the data structure of the response from Facebook, whether to return data in Bloks or JSON form. Bloks is a proprietary format of Facebook, so we suggest setting this parameter to true

education_id

No

Body Param

String | Education ID filter, use the search filters endpoint to get values for here.

work_id

No

Body Param

String | work ID filter, use the search filters endpoint to get values for here.

city_id

No

Body Param

String | tagged location filter - use search filters endpoint with city filter type to get this value

Example Request
Example Response

Search Groups

Description

This endpoint allows you to search for groups on Facebook that match the provided query. It retrieves groups that contain the specified search term.

Endpoint

POST api/v1/realtime/social/facebook/v1/search/groups

Parameters

Param
Required
Param Type
Description

typed_query

Yes

Body Param

String | The search query string used to find matching content across Facebook.

end_cursor

No

Body Param

String | The cursor to paginate

disable_blocks

No

Body Param

Boolean | This parameter allows you to decide the data structure of the response from Facebook, whether to return data in Bloks or JSON form. Bloks is a proprietary format of Facebook, so we suggest setting this parameter to true

city_id

No

Body Param

String | tagged location filter - use search filters endpoint with city filter type to get this value

Example Request
Example Response

Search Hashtags

Description

This endpoint allows you to search for users on Facebook that match the provided query. It retrieves user profiles that contain the specified search term.

Endpoint

POST api/v1/realtime/social/facebook/v1/search/hashtags

Parameters

Param
Required
Param Type
Description

hashtag

Yes

Body Param

String | The search query string used to find hashtag content across Facebook.

session_id

Yes

Body Param

String | A UUID version 5 used for ranking and pagination. For each request, generate a new UUID, and use the same rank_token for all pagination requests

topic_results_paginating_after_cursor

No

Body Param

String | The cursor to paginate

filter

No

Body Param

Enum: recent_posts | videos | reels_tab

Example Request
Example Response

Search Pages

Description

This endpoint allows you to search for pages on Facebook that match the provided query. It retrieves pages that contain the specified search term.

Endpoint

POST api/v1/realtime/social/facebook/v1/search/hashtags

Parameters

Param
Required
Param Type
Description

typed_query

Yes

Body Param

String | The search query string used to find matching content across Facebook.

end_cursor

No

Body Param

String | The cursor to paginate

disable_blocks

No

Body Param

Boolean | This parameter allows you to decide the data structure of the response from Facebook, whether to return data in Bloks or JSON form. Bloks is a proprietary format of Facebook, so we suggest setting this parameter to true

recent_post

No

Body Param

Boolean | set true add a recent posts search filter

location_id

No

Body Param

String | Filter by locations.

category_id

No

Body Param

Enum: Local Business or Place - 1006

Company, Organization or Institution - 1013

Brand or Product - 1009

Artist, Band or Public Figure - 1007

Entertainment - 1019

Cause or Community - 2612

Example Request
Example Response

Search Filters (Helpers)

Description

This endpoint allows you to apply filters to your Facebook search results based on the specified criteria. It helps refine search results to match particular filter types.

Endpoint

POST api/v1/realtime/social/facebook/v1/search/filters

Parameters

Param
Required
Param Type
Description

filter_type

Yes

Body Param

String | The type of filter to apply to the search results:

  • city

  • education

  • work

query

Yes

Body Param

String | The value to filter by, such as a city name.

Example Request
Example Response

Last updated