{
  "openapi": "3.0.1",
  "info": {
    "title": "Instagram User Search Scraper",
    "description": "Instagram user search scraper: search accounts by keyword the way the app's search box does: username, name, verified and private flags, picture. Add profile details for followers, bio, links, category and business contacts. Also finds hashtags and places.",
    "version": "0.1",
    "x-build-id": "g2yoCivQwX3Iv8j9B"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dami_studio~instagram-user-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dami_studio-instagram-user-search-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/dami_studio~instagram-user-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-dami_studio-instagram-user-search-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/dami_studio~instagram-user-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-dami_studio-instagram-user-search-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "searchQueries": {
            "title": "Search words",
            "type": "array",
            "description": "Words, names or phrases, one per line, as you'd type them into Instagram's search: \"yoga teacher\", \"coffee roaster berlin\", \"nasa\". Up to 20 a run.",
            "items": {
              "type": "string"
            }
          },
          "searchType": {
            "title": "Search for",
            "enum": [
              "accounts",
              "hashtags",
              "places"
            ],
            "type": "string",
            "description": "Accounts (the default), hashtags with their post counts, or places with their address and map position.",
            "default": "accounts"
          },
          "maxResultsPerQuery": {
            "title": "Results per search word",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "How many results to keep for each search word. Instagram's own search goes a few dozen deep for most words.",
            "default": 20
          },
          "maxResults": {
            "title": "Maximum results in all",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "The run stops after this many results across every search word, so a long list can't cost more than you expect.",
            "default": 100
          },
          "includeProfileDetails": {
            "title": "Add profile details",
            "type": "boolean",
            "description": "Accounts only. Read each account's profile: followers, following, posts, bio, website and bio links, category, account type, and the e-mail, phone and address a business chooses to show. Charged per account it's added to, on top of the result.",
            "default": false
          },
          "verifiedOnly": {
            "title": "Verified accounts only",
            "type": "boolean",
            "description": "Keep only accounts with Instagram's blue check.",
            "default": false
          },
          "includePrivateProfiles": {
            "title": "Include private accounts",
            "type": "boolean",
            "description": "Private accounts come back with their name and picture only. Turn this off to leave them out.",
            "default": true
          },
          "excludeAccounts": {
            "title": "Skip these accounts",
            "type": "array",
            "description": "Handles or profile links to leave out, for example accounts you already have.",
            "items": {
              "type": "string"
            }
          },
          "minFollowers": {
            "title": "Minimum followers",
            "minimum": 0,
            "type": "integer",
            "description": "Needs \"Add profile details\". Keep accounts with at least this many followers."
          },
          "maxFollowers": {
            "title": "Maximum followers",
            "minimum": 0,
            "type": "integer",
            "description": "Needs \"Add profile details\". Keep accounts with at most this many followers."
          },
          "accountType": {
            "title": "Account type",
            "enum": [
              "any",
              "personal",
              "business",
              "creator",
              "professional"
            ],
            "type": "string",
            "description": "Needs \"Add profile details\". Personal, business or creator; professional means business or creator.",
            "default": "any"
          },
          "bioKeywords": {
            "title": "Bio must contain",
            "type": "array",
            "description": "Needs \"Add profile details\". Keep accounts whose bio or name contains any of these words.",
            "items": {
              "type": "string"
            }
          },
          "excludeBioKeywords": {
            "title": "Bio must not contain",
            "type": "array",
            "description": "Needs \"Add profile details\". Leave out accounts whose bio or name contains any of these words.",
            "items": {
              "type": "string"
            }
          },
          "onlyWithEmail": {
            "title": "Only accounts that show an e-mail",
            "type": "boolean",
            "description": "Needs \"Add profile details\". Keep business accounts that publish a contact e-mail on their profile.",
            "default": false
          },
          "onlyWithWebsite": {
            "title": "Only accounts with a website",
            "type": "boolean",
            "description": "Needs \"Add profile details\". Keep accounts that have a website or links in their bio.",
            "default": false
          },
          "includeLatestPosts": {
            "title": "Add latest posts",
            "type": "boolean",
            "description": "Paid. Each account's latest posts, the first page of its grid, newest first (link, type, date, likes, comments, views, caption), with average likes and comments, median views, posts a week and days since the last post. The engagement rate needs \"Add profile details\" too.",
            "default": false
          },
          "includeRelatedProfiles": {
            "title": "Add related profiles",
            "type": "boolean",
            "description": "Paid. The accounts Instagram suggests beside each account: username, name, id, verified, private, link.",
            "default": false
          },
          "includeAccountAbout": {
            "title": "Add country and join date",
            "type": "boolean",
            "description": "Paid. From each account's \"About this account\" panel: the country, the date it joined and how many former usernames it has, when Instagram shows them.",
            "default": false
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}