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

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

No

Body Param

String | The search term or keyword to find products on Facebook Marketplace.

virtual_category_id

No

Body Param

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

Example Request
curl -X POST 'https://api.webit.live/api/v1/realtime/social/facebook/v1/marketplace/search' \
--header 'Authorization: Basic <credential string>' \ 
--data '{
    "query": "tesla",
    "filter_location_latitude": 34.0522,
    "filter_location_longitude": -118.24588,
    "virtual_category_id": "139967891347278"
}'
Example Response
{
    "data": {
        "marketplace_search": {
            "feed_units": {
                "session_id": "aa6344c9-0b7c-4fa6-9079-cff26f6ac9eb",
                "logging_unit_id": "browse_serp:562a5199-7d7b-49b2-b202-a153097586f0",
                "layout_type": "GRID_VIEW",
                "edges": [
                    {
                        "sort_key": "1",
                        "unit_position": 1,
                        "logging_unit_id": "browse_rl:d1520382-1d30-4674-ac6c-bb1783803c83",
                        "node": {
                            "__typename": "MarketplaceFeedGeneralListingObject",
                            "id": "8193315984044480:IN_MEMORY_MARKETPLACE_FEED_STORY_ENT:MarketplaceFeedGeneralListingObject:503:GRID_VIEW",
                            "story_key": "8193315984044480",
                            "story_type": "GENERAL_LISTING",
                            "tracking": "{\"qid\":1,\"mf_story_key\":\"8193315984044480\",\"top_level_post_id\":\"8193315984044480\",\"commerce_rank_obj\":\"{\\\"target_id\\\":8193315984044480,\\\"target_type\\\":0,\\\"primary_position\\\":-1,\\\"ranking_signature\\\":0,\\\"commerce_channel\\\":503,\\\"value\\\":0,\\\"upsell_type\\\":null,\\\"candidate_retrieval_source_map\\\":null,\\\"grouping_info\\\":null}\"}",
                            "__isMarketplaceFeedGeneralListingData": "MarketplaceFeedGeneralListingObject",
                            "view_layout": "GRID_VIEW",
                            "entity_id": "8193315984044480",
                            "reportable_id": "UzpfSTEwMDA2NzM5Mzg0NzQ2MTpWSzo0OTI5OTIzODAwNDEyOTY=",
                            "photo": {...},
                            "three_d_object": null,
                            "photoCoverFillCrop": {...},
                            "data": {...},
                            "row_1": {...},
                            "row_2": {...},
                            "row_3": {...},
                            "row_4": null,
                            "row_5": null,
                            "badge_bottom_left": null,
                            "savable": {...},
                            "savable_default_collection": null,
                            "__isMarketplaceFeedStory": "MarketplaceFeedGeneralListingObject"
                        },
                        "cursor": null
                    },
                    ...
                ],
                "page_info": {
                    "has_next_page": true,
                    "end_cursor": "..."
                },
                "qpl_annotations": null
            }
        }
    },
    "extensions": {
        "server_metadata": {
            "request_start_time_ms": 1724671013548,
            "time_at_flush_ms": 1724671014745
        },
        "is_final": true
    }
}

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.

Example Request
curl -X POST 'https://api.webit.live/api/v1/realtime/social/facebook/v1/marketplace/profile/100083274664436' \
--header 'Authorization: Basic <credential string>'
Example Response
{
    "data": {
        "allBadges": {
            "summary": "Marlen has 1 seller badge from 1 place.",
            "badges": [...]
        },
        "badges": {
            "badges": [...],
            "profile_badges": [...],
            "source_badge_basis_description": "Based on Marlen's activity on Marketplace",
            "summary": "Marlen has 1 seller badge from 1 place."
        },
        "profile": {
            "customized_profile": {...},
            "id": "100083274664436",
            "marketplace_user_profile": {...},
            "name": "Marlen Nicolas",
            "expanded_profile_picture": {...},
            "marketplace_profile_share_id": "101566259295863",
            "marketplace_profile_share_uri": "https://www.facebook.com/marketplace/profile/100083274664436/?ref=permalink",
            "profile_picture": {...},
            "commerce_profile_picture_132": null,
            "timeline_context_items": {...},
            "short_name": "Marlen",
            "marketplace_user_badges": [],
            "cover_photo": {...},
            "commerce_cover_photo": {...},
            "__isActor": "User",
            "__isActorWithCustomizableCommerceProfile": "User",
            "marketplace_seller_vacation_mode_enabled": null,
            "marketplace_seller_custom_vacation_mode_message": null,
            "bsg_group_inventory": null,
            "gender": "FEMALE",
            "unified_inventory": {...},
            "marketplace_user_public_settings": {...},
            "marketplace_ratings_stats_by_role": {...},
            "__isProfile": "User",
            "first_name": "Marlen",
            "viewer": {...},
            "profile_photo": {...}
        },
        "viewer": {
            "actor": {...},
            "marketplace_settings": {...},
            "marketplace_nux_states": {...},
            "last_location": null,
            "marketplace_seller_requesting_ratings_listings": {}
        }
    },
    "extensions": {
        "server_metadata": {
            "request_start_time_ms": 1724671272710,
            "time_at_flush_ms": 1724671273149
        },
        "is_final": true
    }
}

Marketplace Category View

Description

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

Endpoint

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.

Example Request
curl -X POST 'https://api.webit.live/api/v1/realtime/social/facebook/v1/marketplace/category/807311116002614' \
--header 'Authorization: Basic <credential string>' \
--data '{
    "filter_location_latitude": 34.0522,
    "filter_location_longitude": -118.24588
}'
Example Response
{
    "data": {
        "marketplace_search": {
            "feed_units": {
                "edges": [
                    {
                        "node": {...},
                        "cursor": null
                    },
                    ...
                ],
                "page_info": {...}
            }
        },
        "sellerProfile": null,
        "friendProfile": null,
        "flashSaleEvent": null,
        "viewer": {
            "marketplace_nux_states": {
                "pdp_buy_now_check_out_nux": "VISIBLE"
            },
            "verticals_inventory_page_checks": {
                "show_listing_creation": false
            }
        },
        "c2cShippedBuyerPromotion": null,
        "mcomOfferContent": {
            "__isMarketplaceFeedMCOMTHFeaturedPageSellersUnit": "MarketplaceFeedMCOMTHFeaturedPageSellersUnitObject",
            "offer_content": null,
            "id": "1234:IN_MEMORY_MARKETPLACE_FEED_STORY_ENT:MarketplaceFeedStoryBase:1000"
        }
    },
    "extensions": {
        "prefetch_uris": [...],
        "prefetch_uris_v2": [...],
        "server_metadata": {
            "request_start_time_ms": 1724671703105,
            "time_at_flush_ms": 1724671704569
        },
        "is_final": true
    }
}

Last updated