Endpoints
2 endpoints return places on Facebook Marketplace and Instagram.
Schema
Single-item endpoints return this object as data; list endpoints return an array of them as data with a page object. The standard meta comes with every response.
platformstringPlatform ID (tiktok, instagram, …).
idstringPlatform-native place ID (TikTok POI ID, Instagram location ID, Facebook Page ID).
namestringPlace name as the platform shows it.
urlstring uriCanonical place page URL.
typestringCoarse kind: venue for one spot (a business, landmark or address), area for a region (a neighborhood, city, state or country); unknown when the platform does not say. New values may be added; treat unknown values as unknown.
One ofvenueareaunknown
categorystringnullableThe platform's category label (Cafe, City, Pizza Fast Food), as shown; not normalized across platforms.
descriptionstringnullableThe place's description or about text; null when none is shown.
addressstringnullableAddress as the platform shows it: a street line on some platforms, the whole postal address or only the enclosing region on others; not normalized.
citystringnullableCity or locality, as shown.
postal_codestringnullablePostal or ZIP code.
country_codestringnullableISO 3166-1 alpha-2 country of the place.
latitudenumbernullableWGS 84 latitude in degrees; null when the platform does not show coordinates (set together with longitude).
longitudenumbernullableWGS 84 longitude in degrees; null when the platform does not show coordinates (set together with latitude).
phonestringnullableThe business's public phone number, as shown; null when none is shown.
website_urlstring urinullableThe place's own website.
price_rangeintegernullableThe business's price range, 1 (inexpensive, $) to 4 (expensive, $$$$); null when the platform shows none.
imagesobject[]Pictures of the place the platform shows, in its order; each of type image. [] when none (listed in unknown_fields when the source cannot see them). Platform CDN URLs can expire within hours: see expires_at.
ShowHide 8 child fields
typestringKind of file. New values may be added; treat unknown values as other.
One ofimagevideoaudiogif
urlstring urinullableDirect file URL; null when the platform withholds it, or when the link would only work from SocialTap's network or with a login. Often signed and expiring: see expires_at.
expires_atstring date-timenullableWhen url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown or when it does not expire.
thumbnail_urlstring urinullablePoster or preview image URL.
widthintegernullableWidth in pixels.
heightintegernullableHeight in pixels.
duration_msintegernullableDuration in milliseconds (video and audio only).
alt_textstringnullableAccessibility text provided by the author or platform.
accountobjectnullableThe platform account that represents the place (its business account or Page); null when none is linked.
ShowHide 6 child fields
idstringnullablePlatform-native account ID; null when only the handle is known.
usernamestringnullableHandle without the @; null when the account has none.
display_namestringnullableDisplay name shown on the profile.
urlstring urinullableCanonical profile URL.
avatar_urlstring urinullableProfile picture URL. Platform CDN URLs can expire within hours.
is_verifiedbooleannullablePlatform verification badge; null where the platform has no badge.
metricsobjectCounts at fetch time; null = hidden or not exposed, 0 = zero.
ShowHide 3 child fields
post_countintegernullablePublic posts tagged with the place, as the platform counts them.
review_countintegernullablePublic reviews or recommendations of the place, as the platform counts them.
image_countintegernullablePictures the platform has of the place; more than the length of images when the source returns only the first ones.
platform_specificobjectFields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.
ShowHide 3 child fields
tiktokobjectnullableA TikTok POI's own fields.
ShowHide 6 child fields
category_pathstring[]TikTok's category from broadest to most specific (Food and Drink, Fast Food, Pizza Fast Food), repeats dropped; category is the last. [] when TikTok shows none (listed in unknown_fields when the source cannot see it).
parent_idstringnullableID of the place TikTok files this one under (the city of a venue); a TikTok place ID. Null for a top-level place or when unknown.
parent_namestringnullableName of the place in parent_id.
ratingnumbernullableAverage TikTok review score out of 5 (metrics.review_count reviews behind it); null when the place is unrated.
is_claimedbooleannullableTrue when a business has claimed the place on TikTok, false when none has; null when unknown.
highlightsstring[]The highlight tags TikTok shows from reviews (Excellent service, Pleasant atmosphere); [] when none (listed in unknown_fields when the source cannot see them).
instagramobjectnullableAn Instagram location's own fields.
ShowHide 1 child field
facebook_place_idstringnullableID of the Facebook place (Page) behind the location: the id of the same place on facebook. Null when none is linked or the source does not show it.
facebookobjectnullableA Facebook place's own fields.
ShowHide 1 child field
checkin_countintegernullablePeople who checked in at the place, as Facebook shows it; null when Facebook shows no count (it shows none for a city).
approximate_fieldsstring[]JSON paths of values rounded by the platform or parsed from display text (e.g. metrics.post_count). [] when all exact.
unknown_fieldsstring[]JSON paths of lists whose [] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. [] when every list is known.
Item errors
Besides the request-level errors every endpoint can return, place endpoints return:
| Code | HTTP | Retry | Meaning | What to do |
|---|---|---|---|---|
not_found | 404 | No | The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why). | Check the link or ID. Do not retry. |