API reference · Instagram

instagram/bulk/search

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

APIAsyncOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDinstagram/bulk/search

Input Schema

5 parameters · 1 required · 4 optional

Parameter	Type	Required	Description
`search`	string	Required	Provide a keyword which will be used to extract Instagram search results. A keyword can be one or more words. To scrape multiple search terms at once, submit them as a comma-separated list. · Default: "restaurant, restaurant prague"
`liveSearch`	boolean	Optional	Enable this option if you want to get data from a live Instagram search. Please note that the dataset will be slightly different than the one produced by standard search.
`searchType`	string	Optional	Choose the type of Instagram page to search for (places, profiles, or hashtags), or `Search popular reels` to scrape trending reels for the keyword. · Options: place, user, hashtag, popular · Default: "place" placeuserhashtagpopular
`searchLimit`	integer	Optional	Set the maximum number of search results (hashtags, users, or places) you want to scrape. If you set it to 5, you'll get 5 results for each search term you've included. · Min: 1 · Max: 250
`enhanceUserSearchWithFacebookPage`	boolean	Optional	For each user from the top 10, the scraper will extract their Facebook page that sometimes contains their business email. Keep in mind that you're forbidden to collect personal data in certain jurisdictions. See this article for more details.

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

Submit — POST to /v1/run, receive an id
Poll — GET /v1/run/{id} until status is completed, failed, or timeout
Retrieve — Read outputs from the completed response

Code Examples

Ready-to-run snippets

# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "instagram/bulk/search",
  "search": "restaurant, restaurant prague",
  "searchType": "place",
  "prompt": "a beautiful sunset over mountains"
}'

# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
  -H "Authorization: Bearer YOUR_API_KEY"

← Back to Instagram Search