{
  "openapi": "3.0.1",
  "info": {
    "title": "Vimeo Scraper: Creators, Videos & Likes",
    "description": "Vimeo creators and videos: followers, video count, location, bio, websites, skills, plan, available for hire, plus videos with likes, comments, plays where shown, duration, tags and dates. Search or links.",
    "version": "0.3",
    "x-build-id": "UuEcDh3JfqBh6opY3"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tacps126~vimeo-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tacps126-vimeo-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/tacps126~vimeo-scraper/runs": {
      "post": {
        "operationId": "runs-sync-tacps126-vimeo-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/tacps126~vimeo-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-tacps126-vimeo-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": {
          "platforms": {
            "title": "Platform",
            "type": "array",
            "description": "Vimeo. YouTube, Instagram, TikTok and Vimeo together are in Creator Finder (tacps126/creator-finder).",
            "items": {
              "type": "string",
              "enum": [
                "vimeo"
              ],
              "enumTitles": [
                "Vimeo"
              ]
            },
            "default": [
              "vimeo"
            ]
          },
          "startUrls": {
            "title": "Profile and video links",
            "type": "array",
            "description": "Vimeo profile links (vimeo.com/staff), usernames or video links. Profiles return the profile plus its latest videos.",
            "items": {
              "type": "string"
            }
          },
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "Names or topics. Returns Vimeo creators whose name matches and creators of matching videos.",
            "items": {
              "type": "string"
            }
          },
          "profilesPerSearch": {
            "title": "Profiles per search term",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "How many matching profiles to read per search term.",
            "default": 20
          },
          "itemsPerProfile": {
            "title": "Latest videos per profile",
            "minimum": 0,
            "maximum": 5000,
            "type": "integer",
            "description": "Videos returned under each profile. Engagement is worked out from the latest 3 or more either way. 0 returns profiles only.",
            "default": 3
          },
          "artistType": {
            "title": "Verified",
            "enum": [
              "all",
              "verified",
              "unverified"
            ],
            "type": "string",
            "description": "Keep only verified or unverified profiles.",
            "default": "all"
          },
          "minFollowers": {
            "title": "Min followers",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only profiles with at least this many followers."
          },
          "maxFollowers": {
            "title": "Max followers",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only profiles with at most this many followers (useful for finding emerging artists)."
          },
          "minEngagementRate": {
            "title": "Min engagement rate (%)",
            "minimum": 0,
            "maximum": 100,
            "type": "number",
            "description": "Keep only creators whose latest videos or posts get at least this engagement: (likes + comments) per view on YouTube and Vimeo, per follower on Instagram and TikTok."
          },
          "releasedWithinDays": {
            "title": "Posted within (days)",
            "minimum": 1,
            "maximum": 3650,
            "type": "integer",
            "description": "Keep only creators whose latest video or post is at most this many days old, so you only get active creators."
          },
          "countries": {
            "title": "Countries",
            "type": "array",
            "description": "2-letter country codes (US, GB, NG). Vimeo profiles rarely give a country; leave empty.",
            "items": {
              "type": "string"
            }
          },
          "mustHave": {
            "title": "Must have",
            "type": "array",
            "description": "Keep only profiles that list all of these (from their profile links and bio).",
            "items": {
              "type": "string",
              "enum": [
                "instagram",
                "tiktok",
                "youtube",
                "x",
                "facebook",
                "website",
                "email"
              ],
              "enumTitles": [
                "Instagram",
                "TikTok",
                "YouTube",
                "X (Twitter)",
                "Facebook",
                "Website",
                "E-mail in bio"
              ]
            }
          },
          "minLeadScore": {
            "title": "Min lead score",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Every creator gets a 0 to 100 score for how well they fit for a brand deal or collaboration: 1k-100k followers, engagement, recent posts, e-mail, other platforms. Keep only profiles at or above this score."
          },
          "socialStats": {
            "title": "Instagram and TikTok stats",
            "type": "array",
            "description": "For profiles that link an Instagram or TikTok account, add its followers, posts or likes, verified badge, bio and (TikTok) average views and engagement (instagramStats, tiktokStats). Charged per account read; only for profiles that pass your filters.",
            "items": {
              "type": "string",
              "enum": [
                "instagram",
                "tiktok"
              ],
              "enumTitles": [
                "Instagram",
                "TikTok"
              ]
            }
          },
          "maxItems": {
            "title": "Max results",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Most rows per run: profiles and videos together.",
            "default": 500
          },
          "onlyNew": {
            "title": "Only new profiles and videos",
            "type": "boolean",
            "description": "Schedule the Actor and each run returns only profiles and videos earlier runs did not deliver. Good for spotting new artists for a search term or new releases from a list of profiles.",
            "default": false
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Optional name for the \"only new\" history, so several monitors can run side by side."
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Apify proxy on by default. Leave it as is unless you want to use your own proxy.",
            "default": {
              "useApifyProxy": true
            }
          },
          "tenantId": {
            "title": "Tenant ID",
            "type": "string",
            "description": "Optional label used to keep separate histories for different clients or teams."
          },
          "debug": {
            "title": "Debug",
            "type": "boolean",
            "description": "Verbose logs.",
            "default": false
          },
          "delivery": {
            "title": "Send results to Slack, Discord, a webhook or Google Sheets",
            "type": "object",
            "description": "Webhook: {\"webhookUrl\": \"https://...\", \"format\": \"json\" | \"slack\" | \"discord\", \"onlyWhenResults\": true, \"includeItems\": 10}. Google Sheets: {\"spreadsheetId\": \"<id from the sheet URL>\", \"sheetName\": \"Sheet1\"} plus the service account key below; share the sheet with the service account's e-mail first. Leave empty to only save results in the dataset."
          },
          "googleServiceAccountJson": {
            "title": "Google service account key (for Sheets)",
            "type": "string",
            "description": "Only for Google Sheets delivery: paste the service account's JSON key. Stored encrypted; the account sees only sheets you share with it."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}