Resources
In this article, you can review the detailed descriptions of the objects used in Local API.
Jump to Location objectLocation object
Parameters
location_id
Unique identifier for this location.
Output only.
Value/Type: string
business_name
Official public name of the business.
Max. length is 125 characters.
Value/Type: string
phone_number
Primary contact phone number for the business.
International format is required. For example: "+49 351 8629318", "+1 541-754-3010"
Value/Type: string
country
Two-letter country code where the business is located, as defined by the ISO 3166-1 code reference (the Alpha-2 code column).
Supported values: US, AU, FR, DE, GB, CA, IN, ES, IT, NL, BR, AT, BE, DK, FI, NO, PL, SE, CH, JP, MX, IL, NZ, SG, ZA, TR, AE, HK, ID, VN, PK, CO, IE, BD, MY, SA, RO, CL, PH, PT, NG, GR, TH, AR, PE, KE, HU, CZ, RS, NP, LT, UA, BG, EC, CY, HR, EE, LV, IS, SK, SI, AM, AD, PY, GY, EG, MV, UY, SR, KH, BO, LA, MT, PA, PR, TN, DO, MN, GU, VE, ME, MP
The list of supported countries will increase in the future.
Value/Type: string
region
Highest administrative subdivision for postal addresses in a country or region. For example, a state, province, oblast, or prefecture.
Specifically, for Spain this is the province rather than the autonomous community (for example, "Barcelona" instead of "Catalonia").
Many countries do not use administrative areas in postal addresses.
Required for Canada, Australia, Brazil, India, and US. Shouldn’t be specified for other countries.
Value/Type: string
city
City or locality name.
Max. length is 64 characters.
Value/Type: string
zip
Postal or ZIP code.
Required for the following countries: US, AU, FR, DE, GB, CA, IN, ES, IT, NL, BR, AT, BE, DK, FI, NO, PL, SE, CH, JP, MX, IL, NZ, SG, ZA, TR, ID, VN, PK, CO, IE, BD, MY, SA, RO, CL, PH, PT, NG, GR, TH, AR, PE, KE, HU, CZ, RS, NP, LT, UA, BG, EC, CY, HR, EE, LV, IS, SK, SI, AM, AD, PY, EG, MV, UY, KH, LA, MT, PA, PR, TN, DO, MN, GU, VE, ME, MP
Value/Type: string
address_line_1
Street address, including house number and street name.
Max. length is 190 characters.
Value/Type: string
address_line_2
Supplemental address information (for example, suite, floor, or building).
Max. length is 64 characters.
Value/Type: string
website_url
URL for the business. Must start with https://.
If possible, use a URL specific to this location rather than a generic brand website.
Max. length is 255 characters.
Value/Type: string
description
Detailed description of the business and its services.
Min. length is 10 characters. Max. length is 750 characters.
Value/Type: string
category_ids
List of category identifiers (max. 10) that describe the business and help customers find relevant services.
Identifiers must be retrieved from the Get Categories endpoint.
Value/Type: array of strings
gbp_category_ids
List of category identifiers (max. 10) that describe the business and help customers find relevant services in GBP.
Identifiers must be retrieved from the Get GBP Categories endpoint.
Value/Type: array of strings
gbp_attributes
List of Attribute objects for the location (for example, wi_fi, wheelchair_accessible). These attributes are category-specific and provide additional details about the business.
Values must be retrieved from the Get GBP Attributes endpoint.
Value/Type: array of objects
suppress_address
If set to true, the physical address is hidden from public listings and search results.
If the address is hidden, service_area_places must be populated to define the business’s geographic reach.
Value/Type: boolean
featured_message
Promotional message or announcement displayed on the business profile.
Max. length is 50 characters.
Value/Type: string
featured_message_url
Call-to-action URL associated with the featured message.
Example: "https://www.semrush.com/local-business/start/"
Max. length is 255 characters.
Value/Type: string
youtube_video
URL of a YouTube video showcasing the business.
Example: "https://www.youtube.com/watch?v=ndJB4J951_k"
Max. length is 150 characters.
Value/Type: string
instagram_username
Instagram profile handle.
Example: semrush
Max. length is 30 characters.
Value/Type: string
twitter_username
X (formerly Twitter) profile handle.
Example: semrush
Max. length is 15 characters.
Value/Type: string
reopen_date
Date ("YYYY-MM-DD") when a temporarily closed location is scheduled to reopen.
This must be a future date and is only applicable if the location status is set to temporarily closed.
Value/Type: string
payment_options
Supported payment methods for the business.
Identifiers must be retrieved from the Get Payment Options endpoint.
Value/Type: array of strings
location_status
Supported values: "COMPLETED", "PROCESSING", "FAILED".
Current status of the location.
COMPLETED: Location is ready for use. All features and data management are fully accessible.
PROCESSING: Location is currently being initialized. Data editing is unavailable until the process completes.
FAILED: Location could not be created. This status does not consume user limits. You may delete the location and create a new location using your existing limit. Contact Semrush Customer Support if the issue persists.
Output only.
Value/Type: string
frozen
If true, the location is frozen due to an overdue payment. A frozen location cannot be edited, and management actions cannot be performed on its associated resources (such as images, listings, etc.).
Output only.
Value/Type: boolean
submit_date
Date and time when the location was first submitted in the "YYYY-MM-DDThh:mm:ss" format (for example, "2026-03-10T17:03:42").
Output only.
Value/Type: string
Jump to Business Hours objectBusiness Hours object
Parameters
Jump to Hour Range objectHour Range object
Parameters
from
Start of the interval in the "HH:MM" format (for example, "09:00").
The maximum value is "23:59", and the minimum value is "00:00".
Value/Type: string
to
End of the interval in the "HH:MM" format (for example, "20:00").
The maximum value is "23:59", and the minimum value is "00:00".
Value/Type: string
Jump to Special Hours objectSpecial Hours object
Parameters
type
Supported values: "CLOSED", "OPENED_ALL_DAY", "RANGE".
If the value is "RANGE", the times parameter must be specified.
If the value is "CLOSED" or "OPENED_ALL_DAY", the times parameter must not be specified.
Value/Type: string
day
Date of the specified item. Must be in the "yyyy-mm-dd" format.
The value must be unique across all special_hours entries—only one item is allowed for each date.
Value/Type: string
times
List of Hour Range objects. Must be specified only for type = "RANGE".
The time ranges of the specified day (or consecutive specified days) can’t overlap.
Value/Type: array of objects
Jump to More Hours objectMore Hours object
Parameters
type
Type of hours. Valid values must be retrieved from the Get More Hour Types endpoint.
Value/Type: string
hours
Weekly operating schedule for this hour type. An empty list implies the location is closed. The Business Hours object.
Value/Type: object
Jump to Service Area Place objectService Area Place object
Parameters
name
"Manhattan"). Max. length is 80 characters.Value/Type: string
place_id
Unique identifier for the location (Google Place ID).
Get the Google Place ID from the Google Maps Platform documentation.
Max. length is 500 characters.
Value/Type: string
Jump to Coordinates objectCoordinates object
Parameters
latitude
Latitude in decimal degrees (for example, 40.7128).
Min. value is -90, max. value is 90.
Value/Type: double
longitude
Longitude in decimal degrees (for example, -74.0060).
Min. value is -180, max. value is 180.
Value/Type: double
Jump to Error objectError object
Parameters
code
Unique, machine-readable string identifying the error type (for example, "INVALID_ZIP_CODE").
Value/Type: string
message
Human-readable explanation of the error to help with debugging.
Value/Type: string
Jump to Image objectImage object
Parameters
id
Unique identifier for the image.
Value/Type: string
type
Image category.
Supported values: PHOTO, PROFILE, COVER.
Value/Type: string
url
Public URL where the image can be accessed or downloaded.
Value/Type: string
description
Caption describing the image content.
Value/Type: string
create_date
Timestamp when the image was created, in the ISO 8601 format (YYYY-MM-DDThh:mm:ss).
Value/Type: string
Jump to Listing objectListing object
Parameters
id
Unique identifier of the listing across all listing platforms.
Value/Type: string
status
Current connection status of the listing.
Supported values: CONNECTED, SUBMITTED, UNAVAILABLE, DISCONNECTED, PROCESSING.
Value/Type: string
name
Display name of the listing platform (for example, "Apple Maps", "Google Business Profile").
Value/Type: string
controllable
Indicates if the listing can be toggled (enabled or disabled) by the user.
Value/Type: boolean
url
Public URL of the business profile on the listing platform.
Value/Type: string
parent_id
Identifier of the parent listing, if this listing belongs to a hierarchy. Disabling a parent listing typically affects all its child listings.
Value/Type: string
Jump to Category objectCategory object
Parameters
id
Value/Type: string
name
Value/Type: string
full_name
"Books > Comic book store").Value/Type: string
parent_id
null for top-level categories.Value/Type: string
Jump to Attribute objectAttribute object
Parameters
id
Unique identifier for the attribute (for example, "welcomes_dogs", "has_braille_menu").
Value/Type: string
name
Primary display name of the attribute.
Value/Type: string
values
List of Attribute Value objects representing the possible values for the attribute. One of these values must be specified when updating a location.
Value/Type: array of objects
Jump to Attribute Value objectAttribute Value object
Parameters
option_id
Unique identifier for the option (for example, "true", "false", or a specific ID).
Value/Type: string
label
Human-readable label for the attribute value (for example, "Wheelchair accessible restroom").
Value/Type: string
Jump to Review objectReview object
Parameters
id
Unique identifier of the review.
Value/Type: string
location_id
Identifier of the location this review belongs to.
Value/Type: string
title
Title or headline of the review. Provides a quick summary of the reviewer’s feedback.
Value/Type: string
content
Main text content of the review. This is the core feedback from the user.
Value/Type: string
rating
Star rating given by the reviewer.
Min. value is 0, max. value is 5.
Value/Type: integer
author_name
Name of the person who wrote the review.
Value/Type: string
publish_date
Date and time when the review was published in the "YYYY-MM-DDThh:mm:ss" format (for example, "2025-12-01T12:59:00").
Value/Type: string
publisher
The Publisher object with information about the platform where the review was published.
Value/Type: object
url
Direct link to the review on the publisher’s platform.
Value/Type: string
supports_reply
Indicates if replying to this review is supported by the publisher.
Check this field before calling the Add Review Comment endpoint.
Value/Type: boolean
supports_comment_edit
Indicates if editing an existing comment or reply is supported.
Check this field before calling the Update Review Comment endpoint.
Value/Type: boolean
supports_comment_removal
Indicates if removing an existing comment or reply is supported.
Check this field before calling the Delete Review Comment endpoint.
Value/Type: boolean
comments
List of Review Comment objects associated with this review. They show the conversation thread between the reviewer and the business.
Value/Type: array of objects
Jump to Publisher objectPublisher object
Parameters
name
Human-readable name of the publisher (for example, "Google Maps").
Value/Type: string
Jump to Review Comment objectReview Comment object
Parameters
id
Unique identifier of the comment.
Output only.
Value/Type: string
parent_id
Identifier of the review or comment this comment is responding to.
Value/Type: string
author_name
Name of the comment author.
Output only.
Value/Type: string
content
Main text content of the comment.
Value/Type: string
publish_date
Date and time when the comment was published in the "YYYY-MM-DDThh:mm:ss" format (for example, "2025-12-01T12:59:00").
Output only.
Value/Type: string
by_owner
Indicates if the comment was written by the business owner.
Output only.
Value/Type: boolean
auto_reply
Indicates if the comment was generated automatically.
Output only.
Value/Type: boolean
Jump to GBP Post objectGBP Post object
Parameters
id
Unique identifier of the post.
Value/Type: string
location_id
Unique identifier of the location associated with the post.
Value/Type: string
status
Current status of the post.
Supported values: DRAFT, SCHEDULED, TO_SEND, SENDING, PUBLISHED, FAILED.
Value/Type: string
content
Text content of the post. Either content or image_urls must be specified.
Value/Type: string
image_urls
List of URLs for images included in the post. Either content or image_urls must be specified.
Value/Type: array of strings
call_to_action
The Call to Action object with the button configuration for the post.
Value/Type: object
publication_date
Date and time in UTC when the post was published in the "YYYY-MM-DDThh:mm:ss" format (for example, "2024-05-11T00:28:38").
Value/Type: string
scheduled_date
Date and time in UTC when the post is scheduled to be published in the "YYYY-MM-DDThh:mm:ss" format (for example, "2024-05-11T00:28:38").
Value/Type: string
Jump to Call to Action objectCall to Action object
Parameters
type
Type of the call-to-action button.
Supported values: BOOK, ORDER, SHOP, LEARN_MORE, SIGN_UP, CALL.
Value/Type: string
url
Destination URL for the call-to-action button. Required for all types except CALL.
Example: "https://example.com/learn-more"
Value/Type: string
Last updated: September 11, 2026