# VK Extractor (`jupri/vkontakte`)

💫 Scrape VK.com

- **URL**: https://beta-securitybyobscurity.apify.com/jupri/vkontakte.md
- **Developed by:** [cat](https://beta-securitybyobscurity.apify.com/jupri) (community)
- **Categories:** Videos, Social media
- **Stats:** 72 total users, 13 monthly users, 95.7% runs succeeded, 3 bookmarks
- **User rating**: No ratings yet

## Pricing

$2.00 / 1,000 results

This Actor is paid per result. You are not charged for the Apify platform usage, but only a fixed price for dataset items the Actor outputs.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-result

# README

## 💫 Welcome to VK Scraper

<img height="32" src="https://apify.com/actor-badge?actor=jupri~vkontakte" align="right">

![dont be sad readme is here](https://raw.githubusercontent.com/JupriGH/resources/main/cats/catframe.png)

### ▶️ About VK.com

<img width="480" src="https://upload.wikimedia.org/wikipedia/commons/6/60/VK_Full_Logo_%282021-present%29.svg" align="right">

**VK**  (short for its original name  ***VKontakte***;  [Russian](https://en.wikipedia.org/wiki/Russian_language "Russian language"):  ВКонтакте, meaning  *InContact*) is a Russian online  [social media](https://en.wikipedia.org/wiki/Social_media "Social media")  and  [social networking service](https://en.wikipedia.org/wiki/Social_networking_service "Social networking service")  based in  [Saint Petersburg](https://en.wikipedia.org/wiki/Saint_Petersburg "Saint Petersburg"). VK is available in multiple languages but it is predominantly used by  [Russian speakers](https://en.wikipedia.org/wiki/Russophone "Russophone"). VK users can message each other publicly or privately, edit these messages,[\[3\]](https://en.wikipedia.org/wiki/VK_\(service\)#cite_note-3)  create  [groups](https://en.wikipedia.org/wiki/Group_\(online_social_networking\) "Group (online social networking)"), public pages, and events; share and tag images, audio, and video; and play browser-based games.[\[4\]](https://en.wikipedia.org/wiki/VK_\(service\)#cite_note-4)

As of August 2018, VK had at least 500 million accounts.[\[5\]](https://en.wikipedia.org/wiki/VK_\(service\)#cite_note-usercount-5)  As of November 2022, it was the sixth most popular website in Russia.[\[6\]](https://en.wikipedia.org/wiki/VK_\(service\)#cite_note-6)  The network was also popular in  [Ukraine](https://en.wikipedia.org/wiki/Ukraine "Ukraine")  until it was banned by the  [Verkhovna Rada](https://en.wikipedia.org/wiki/Verkhovna_Rada "Verkhovna Rada")  in 2017.[\[7\]](https://en.wikipedia.org/wiki/VK_\(service\)#cite_note-7)

According to  [Semrush](https://en.wikipedia.org/wiki/Semrush "Semrush"), in 2024 VK is the 30th most visited website in the world.[\[8\]](https://en.wikipedia.org/wiki/VK_\(service\)#cite_note-8)

### ▶️ About This Actor

**💫 All-In-One VK.com Scraper**

### ▶️ Parameters

| Name | Type | Description |
|-|-|-|
| `query` | ***array*** | List of `KEYWORD`, `URL` or `COMMAND` |
| `limit` | ***number*** | Limit number of results *(per-query)* |
| `filters` | ***object*** | Search filters

### ▶️ Basic Usage

**Search for videos**

```yaml
{ "query": ["Spongebob Squarepants"], "limit": 10 }
```

**Search for clips**

```yaml
{ "query": ["Dance"], "filters.kind": "clip", "limit": 10 }
```

**Scrape video info**

```yaml
{ "query": ["https://vk.com/video-152205883_456239241"] }
```

### ▶️ Advanced Usage

```
... TO BE CONTINUED ...
```

### 🍂 Support

Feel free to [reach out](https://console.apify.com/actors/1nSEb9lJnGrwIYQvK/issues) to the developer for any issues or suggestions for improvement.

<img src="https://apify-uploads-prod.s3.us-east-1.amazonaws.com/5SxZhwYwpknFk8ek9-cat.gif" width="240">

# Actor input Schema

## `query` (type: `array`):

💡 <b>Search Terms :</b><p><li><code>KEYWORDS</code><br><b>example:</b> <code>"square pants"</code></li><li><code>VIDEO\_ID</code><br><b>example:</b> <code>"-147758547\_456242827"</code></li></p>

## `filters.kind` (type: `string`):

No description

## `limit` (type: `integer`):

💡 Number of results

## `filters.sort` (type: `string`):

No description

## `filters.duration` (type: `string`):

No description

## `filters.date` (type: `string`):

No description

## `filters.hd` (type: `boolean`):

No description

## `dev_proxy_config` (type: `object`):

💡 <b>Supported protocol:</b><br><br><b>HTTP(S), SOCKS5</b><br><code>{http|socks5}://{user:pass}@{hostname|ip-address}:port</code><br><br><b>Example</b>: <code>socks5://example.com:9000</code>

## `dev_custom_headers` (type: `array`):

💡 Additional HTTP Headers

## `dev_custom_cookies` (type: `array`):

💡 Additional HTTP Cookies

## `dev_transform_fields` (type: `array`):

💡 <b>Transform the resulting output. Select only needed fields.</b><br><br>For nested object use <b>DOT</b>. For example: <pre>address.streetAddress</pre><br>For nested array use <b>NUMBER</b> <i>(index of array element starting from index=0)</i>. For example: <pre>images.0.url</pre>

## `dev_dataset_name` (type: `string`):

💡 <b>Save results into custom named Dataset, use mask to customize dataset name</b><br><br><code>{ACTOR} = actor name<br>{DATE} = date (YYYYMMDD)<br>{TIME} = time (HHMMSS)</code><br><br>This masks can be used to autogenerate Dataset Name.<br><br>example: <i><code>data-{DATE}</code></i><br>Depending on today date the dataset name will be: <code>data-20230603</code><i><br><br>default: <code>data-{ACTOR}-{DATE}-{TIME}</code></i>

## `dev_dataset_clear` (type: `boolean`):

Clear Dataset before insert/update.

## `dev_no_strip` (type: `boolean`):

💡 Keep/Save empty values <i><code>(NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)</code></i>

## Actor input object example

```json
{
  "query": [
    "square pants"
  ],
  "limit": 5
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "query": [
        "square pants"
    ],
    "limit": 5
};

// Run the Actor and wait for it to finish
const run = await client.actor("jupri/vkontakte").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "query": ["square pants"],
    "limit": 5,
}

# Run the Actor and wait for it to finish
run = client.actor("jupri/vkontakte").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "query": [
    "square pants"
  ],
  "limit": 5
}' |
apify call jupri/vkontakte --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=jupri/vkontakte",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "VK Extractor",
        "description": "💫 Scrape VK.com",
        "version": "0.1",
        "x-build-id": "iSawU9JOvuC5EyNwd"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/jupri~vkontakte/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-jupri-vkontakte",
                "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/jupri~vkontakte/runs": {
            "post": {
                "operationId": "runs-sync-jupri-vkontakte",
                "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/jupri~vkontakte/run-sync": {
            "post": {
                "operationId": "run-sync-jupri-vkontakte",
                "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": {
                    "query": {
                        "title": "❓ Query",
                        "type": "array",
                        "description": "💡 <b>Search Terms :</b><p><li><code>KEYWORDS</code><br><b>example:</b> <code>\"square pants\"</code></li><li><code>VIDEO_ID</code><br><b>example:</b> <code>\"-147758547_456242827\"</code></li></p>",
                        "items": {
                            "type": "string"
                        }
                    },
                    "filters.kind": {
                        "title": "🔎 Search Type",
                        "enum": [
                            "video",
                            "clip",
                            "live",
                            "author"
                        ],
                        "type": "string",
                        "description": ""
                    },
                    "limit": {
                        "title": "♾️ Limit",
                        "type": "integer",
                        "description": "💡 Number of results"
                    },
                    "filters.sort": {
                        "title": "Sorting",
                        "enum": [
                            "relevance",
                            "duration",
                            "update"
                        ],
                        "type": "string",
                        "description": ""
                    },
                    "filters.duration": {
                        "title": "Duration",
                        "enum": [
                            "short",
                            "long"
                        ],
                        "type": "string",
                        "description": ""
                    },
                    "filters.date": {
                        "title": "Date uploaded",
                        "enum": [
                            "day",
                            "week",
                            "month",
                            "year"
                        ],
                        "type": "string",
                        "description": ""
                    },
                    "filters.hd": {
                        "title": "HD only",
                        "type": "boolean",
                        "description": ""
                    },
                    "dev_proxy_config": {
                        "title": "🌐 PROXY NETWORKING",
                        "type": "object",
                        "description": "💡 <b>Supported protocol:</b><br><br><b>HTTP(S), SOCKS5</b><br><code>{http|socks5}://{user:pass}@{hostname|ip-address}:port</code><br><br><b>Example</b>: <code>socks5://example.com:9000</code>"
                    },
                    "dev_custom_headers": {
                        "title": "📜 HTTP HEADERS",
                        "type": "array",
                        "description": "💡 Additional HTTP Headers",
                        "items": {
                            "type": "object",
                            "required": [
                                "key",
                                "value"
                            ],
                            "properties": {
                                "key": {
                                    "type": "string",
                                    "title": "Key"
                                },
                                "value": {
                                    "type": "string",
                                    "title": "Value"
                                }
                            }
                        }
                    },
                    "dev_custom_cookies": {
                        "title": "🍰 HTTP COOKIES",
                        "type": "array",
                        "description": "💡 Additional HTTP Cookies",
                        "items": {
                            "type": "object",
                            "required": [
                                "key",
                                "value"
                            ],
                            "properties": {
                                "key": {
                                    "type": "string",
                                    "title": "Key"
                                },
                                "value": {
                                    "type": "string",
                                    "title": "Value"
                                }
                            }
                        }
                    },
                    "dev_transform_fields": {
                        "title": "♻️ CUSTOM FIELD",
                        "type": "array",
                        "description": "💡 <b>Transform the resulting output. Select only needed fields.</b><br><br>For nested object use <b>DOT</b>. For example: <pre>address.streetAddress</pre><br>For nested array use <b>NUMBER</b> <i>(index of array element starting from index=0)</i>. For example: <pre>images.0.url</pre>",
                        "items": {
                            "type": "object",
                            "required": [
                                "key",
                                "value"
                            ],
                            "properties": {
                                "key": {
                                    "type": "string",
                                    "title": "Key"
                                },
                                "value": {
                                    "type": "string",
                                    "title": "Value"
                                }
                            }
                        }
                    },
                    "dev_dataset_name": {
                        "title": "📁 CUSTOM STORAGE",
                        "type": "string",
                        "description": "💡 <b>Save results into custom named Dataset, use mask to customize dataset name</b><br><br><code>{ACTOR} = actor name<br>{DATE} = date (YYYYMMDD)<br>{TIME} = time (HHMMSS)</code><br><br>This masks can be used to autogenerate Dataset Name.<br><br>example: <i><code>data-{DATE}</code></i><br>Depending on today date the dataset name will be: <code>data-20230603</code><i><br><br>default: <code>data-{ACTOR}-{DATE}-{TIME}</code></i>"
                    },
                    "dev_dataset_clear": {
                        "title": "Clear Storage",
                        "type": "boolean",
                        "description": "Clear Dataset before insert/update."
                    },
                    "dev_no_strip": {
                        "title": "Disable data cleansing",
                        "type": "boolean",
                        "description": "💡 Keep/Save empty values <i><code>(NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)</code></i>"
                    }
                }
            },
            "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
                                    }
                                }
                            },
                            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
