Nimble HomeLoginCreate an Account

Marketplace

Marketplace Product

Description

This endpoint retrieves detailed information about a specific product listed on Facebook Marketplace, based on its product ID.

Endpoint

GET api/v1/realtime/social/facebook/v1/marketplace/{{productId}}

Parameters

Param
Required
Param Type
Description

productId

Yes

Path Param

String | The unique identifier for the Facebook Marketplace product whose details are to be retrieved.

Example Request
curl -X GET 'https://api.webit.live/api/v1/realtime/social/facebook/v1/marketplace/565466558909417' \
--header 'Authorization: Basic <credential string>'
Example Response
{
    "data": {
        "viewer": {
            "eligible_promotions": {...},
            "account_user": {...},
            "productDetailsPage": {
                "__typename": "MarketplaceForSaleItemProductDetailsPage",
                "product_details_type": "FOR_SALE_ITEM",
                "__isMarketplaceProductDetailsPage": "MarketplaceForSaleItemProductDetailsPage",
                "scrollable": true,
                "listing_new": null,
                "listing": {...},
                "productDetailsList": {...},
                "id": "66:565466558909417:IN_MEMORY_MARKETPLACE_PRODUCT_DETAILS_PAGE:MarketplaceC2CProductDetailsPage"
            },
            "actor": {...},
            "marketplace_nux_states": {...},
            "marketplace_settings": {...},
            "primary_email": "[email protected]",
            "if_saved_on_save_qe": null,
            "marketplace_ecommerce_cart": null,
            "__typename": "Viewer"
        }
    },
    "extensions": {
        "server_metadata": {
            "request_start_time_ms": 1724670333936,
            "time_at_flush_ms": 1724670334688
        },
        "is_final": true
    }
}

Marketplace Search

Description

This endpoint allows users to search for products on Facebook Marketplace based on various parameters.

Endpoint

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

Virtual Category Ids

Category id is used for searching on a specific category. Use the following ids below as needed to get better results.

Note: if you have a category id that is not below you can try to use it or ask us to add the missing category.

  • 5172443286159237 - Antiques & Collectibles

  • 810528346341232 - Appliances

  • 182863286735694 - Arts & Crafts

  • 139967891347278 - Auto Parts

  • 506454330362852 - Baby

  • 733174934049244 - Books, Movies & Music

  • 909384546527230 - Clothing, Shoes & Accessories

  • 454575972525065 - Electronics

  • 992412274624126 - Furniture

  • 434359961128272 - Garage Sale

  • 258184992549115 - Health & Beauty

  • 849777039085229 - Home Goods & Decor

  • 2576070066024396 - Home Improvements & Tools

  • 436948887562208 - Jewelry & Watches

  • 279762896853334 - Luggage & Bags

  • 488308125664390 - Men's Clothing & Shoes

  • 432652007807083 - Miscellaneous

  • 273374747773247 - Musical Instruments

  • 250936559966850 - Patio & Garden

  • 270088031229000 - Pet Supplies

  • 897479961029905 - Sporting Goods

  • 145833277405533 - Toys & Games

  • 131345812248330 - Women's Clothing & Shoes

Parameters

Param
Required
Param Type
Description

filter_location_latitude

Yes

Body Param

Float | Latitude for filtering search results based on location.

filter_location_longitude

Yes

Body Param

Float | Longitude for filtering search results based on location.

query

Yes

Body Param

String | The search term

virtual_category_id

No

Body Param

String | The ID of the category to filter the search results.

virtual_category_id

No

Body Param

String| ID that represents a category, see description for top used categories

filter_radius_km

No

Body Param

Int | min value 1, max value 200

commerce_search_sort_by

No

Body Param

ENUM: BEST_MATCH (Default) | DISTANCE_ASCEND | CREATION_TIME_DESCEND | PRICE_ASCEND | PRICE_DESCEND

date_listed

No

Body Param

ENUM : ANY (Default) | LAST_24_HOURS | LAST_7_DAYS | LAST_30_DAYS

end_cursor

No

Body Param

The cursor to paginate

Example Request
Example Response

Marketplace Profile

Description

This endpoint retrieves detailed information about a seller’s profile on Facebook Marketplace based on the seller’s profile ID.

Endpoint

POST api/v1/realtime/social/facebook/v1/marketplace/profile/{{sellerProfileId}}

Parameters

Param
Required
Param Type
Description

sellerProfileId

Yes

Path Param

Float | The unique identifier for the seller’s profile whose details are to be retrieved.

search

No

Body param

String | Search term text

order

No

Body Param

ENUM | options are: CREATION_TIMESTAMP_DESC - (default) - order listing from first to last CREATION_TIMESTAMP - order listing from last to first TITLE - Alphabetical order

end_cursor

No

Body Param

String | The cursor to paginate.

Example Request
Example Response

Marketplace Category View

Description

This endpoint retrieves items listed under a specific category on Facebook Marketplace based on the category ID

Endpoint

POST api/v1/realtime/social/facebook/v1/marketplace/category/{{categoryId}}

Parameters

Param
Required
Param Type
Description

categoryId

Yes

Path Param

Float | The unique identifier for the seller’s profile whose details are to be retrieved.

filter_location_latitude

Yes

Body Param

Float | Latitude for filtering search results based on location.

filter_location_longitude

Yes

Body Param

Float | Longitude for filtering search results based on location.

query

No

Body Param

String | The search term

filter_radius_km

Body Param

Int | min value 1, max value 200

commerce_search_sort_by

Body Param

ENUM: BEST_MATCH (Default) | DISTANCE_ASCEND | CREATION_TIME_DESCEND | PRICE_ASCEND | PRICE_DESCEND

end_cursor

No

Body Param

The cursor to paginate

Example Request
Example Response

Last updated