{
  "openapi": "3.0.1",
  "info": {
    "title": "Brand Username Finder & Monitor",
    "description": "Find exact and similar brand usernames on GitHub, GitLab, YouTube, DEV Community, Hugging Face and Keybase. Export confirmed profiles and track changes over time. No source API token required.",
    "version": "0.1",
    "x-build-id": "4iFW9NTnVJRe1L45k"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/thescrapelab~brand-username-profile-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-thescrapelab-brand-username-profile-monitor",
        "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/thescrapelab~brand-username-profile-monitor/runs": {
      "post": {
        "operationId": "runs-sync-thescrapelab-brand-username-profile-monitor",
        "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/thescrapelab~brand-username-profile-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-thescrapelab-brand-username-profile-monitor",
        "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": {
          "brandNames": {
            "title": "Brand names or usernames",
            "minItems": 0,
            "maxItems": 25,
            "type": "array",
            "description": "Enter up to 25 names or usernames, such as apify. Checks matching profile URLs on the selected platforms; matching handles do not prove brand ownership.",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            }
          },
          "platforms": {
            "title": "Platforms",
            "uniqueItems": true,
            "type": "array",
            "description": "Choose from six supported websites. Each username on each platform is a separate check. Known-profile mode uses the platform in each URL.",
            "items": {
              "type": "string",
              "enum": [
                "github",
                "gitlab",
                "youtube",
                "devto",
                "huggingface",
                "keybase"
              ],
              "enumTitles": [
                "GitHub",
                "GitLab",
                "YouTube",
                "DEV Community",
                "Hugging Face",
                "Keybase"
              ]
            }
          },
          "maxResults": {
            "title": "Maximum profiles",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Maximum profile rows exported in this run. The starter limit is 5, so some platforms may remain unchecked. Definitive missing or unchanged checks can also incur a check fee.",
            "default": 1
          },
          "mode": {
            "title": "Collection method",
            "pattern": "^(?:usernameSearch|profileUrls)(?![\\s\\S])",
            "type": "string",
            "description": "Leave Find brand usernames selected for brand searches. Choose Collect known profiles to use the URLs below. API requests without mode keep the original GitHub workflow."
          },
          "ownedProfileUrls": {
            "title": "Known profile URLs",
            "type": "array",
            "description": "Used only with Collect known profiles. Enter public profile URLs on the six supported websites, or GitHub usernames. Brand names and platform selections are ignored in this mode; URLs do not establish ownership.",
            "items": {
              "type": "string"
            }
          },
          "historyName": {
            "title": "Monitoring list name",
            "type": "string",
            "description": "Optional name using lowercase letters, digits and internal hyphens. The first run establishes a baseline; reuse the name on later runs to compare profiles. Run one job at a time per list and leave Resume an unfinished search empty for a new cycle."
          },
          "changePolicy": {
            "title": "Profiles to return",
            "pattern": "^(?:all|newOrChanged)(?![\\s\\S])",
            "type": "string",
            "description": "Return all observations, or only new and updated profiles after the first baseline. Filtering requires a monitoring list name. Confirmed unchanged checks can incur a fee even when no row is exported.",
            "default": "all"
          },
          "monitorFields": {
            "title": "Changes to monitor",
            "uniqueItems": true,
            "type": "array",
            "description": "Optional fields to compare. Leave unset to monitor available profile details and public counts. Unavailable counters do not erase known counts.",
            "items": {
              "type": "string",
              "pattern": "^(?:username|displayName|bio|websiteUrl|location|company|avatarUrl|followersCount|followingCount|publicRepositoriesCount)(?![\\s\\S])"
            }
          },
          "minimumCountChange": {
            "title": "Minimum counter change",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Minimum absolute change since the last delivered snapshot. Smaller changes can accumulate. Positive thresholds ignore rounded counts when an exact change cannot be established.",
            "default": 0
          },
          "includeVariants": {
            "title": "Include similar usernames",
            "type": "boolean",
            "description": "Also check formatting variants such as joined words, hyphens and underscores. Each added username on a platform is another check. Similar usernames do not prove affiliation.",
            "default": false
          },
          "maxVariantsPerName": {
            "title": "Maximum variants per brand",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Includes the base username. Used only when Include similar usernames is enabled. Keep the example value for a small search.",
            "default": 1
          },
          "maxPublicPages": {
            "title": "Maximum public page requests",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Advanced HTTP request limit, including redirects and retries. The Console starter uses 10. A request limit can stop collection before Maximum profiles is reached; inspect pending targets in the run summary.",
            "default": 3
          },
          "resumeKey": {
            "title": "Resume an unfinished search",
            "type": "string",
            "description": "Reuse this key with identical search and monitoring settings to continue pending work. Result and request limits may change. Use lowercase letters, digits and internal hyphens; one active run per key. Omit it or use a fresh key for a new monitoring cycle."
          },
          "analysisQuery": {
            "title": "Find a phrase in profile text",
            "type": "string",
            "description": "Optional literal phrase to find in delivered profile descriptions and bios. Matching records appear in Profile analysis. No AI service or analysis fee."
          },
          "providedRecords": {
            "title": "Import profile records (JSON)",
            "type": "array",
            "description": "Optional profile snapshots to validate and deduplicate. Nonempty records replace live collection and are not independently verified. Use this or a dataset ID.",
            "items": {
              "type": "object"
            }
          },
          "providedDatasetId": {
            "title": "Apify dataset ID",
            "type": "string",
            "description": "Optional accessible dataset of existing profile records. Keep JSON records empty when using a dataset. Imports replace live collection and are not independently verified."
          },
          "maxSitesPerName": {
            "title": "Max platforms per username (legacy)",
            "minimum": 5,
            "maximum": 1000,
            "type": "integer",
            "description": "Inactive in this product workflow. Retained for existing API clients; it does not enable collection, source APIs or filtering of supplied records.",
            "default": 5
          },
          "scanMode": {
            "title": "Scan level (legacy)",
            "pattern": "^(?:fast|balanced|deep)(?![\\s\\S])",
            "type": "string",
            "description": "Inactive in this product workflow. Retained for existing API clients; it does not enable collection, source APIs or filtering of supplied records.",
            "default": "fast"
          },
          "sources": {
            "title": "Sources to check (legacy)",
            "uniqueItems": true,
            "type": "array",
            "description": "Inactive in this product workflow. Retained for existing API clients; it does not enable collection, source APIs or filtering of supplied records.",
            "items": {
              "type": "string",
              "pattern": "^(?:all|social|video|developer|forums|marketplaces|gaming|crypto|music|blogging)(?![\\s\\S])"
            },
            "default": [
              "social"
            ]
          },
          "proxyConfiguration": {
            "title": "Proxy configuration (legacy)",
            "type": "object",
            "description": "Inactive in this product workflow. Retained for existing API clients; it does not enable collection, source APIs or filtering of supplied records.",
            "default": {
              "useApifyProxy": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}