ScrapeBadger\VintedApi

All URIs are relative to https://scrapebadger.com, except if the operation defines another base path.

Method	HTTP request	Description
vintedGetItemDetails()	GET /v1/vinted/items/{item_id}	Get item details
vintedGetUserProfile()	GET /v1/vinted/users/{user_id}	Get user profile
vintedGetUserSListedItems()	GET /v1/vinted/users/{user_id}/items	Get user's listed items
vintedListColors()	GET /v1/vinted/colors	List colors
vintedListItemConditions()	GET /v1/vinted/statuses	List item conditions
vintedListMarkets()	GET /v1/vinted/markets	List markets
vintedSearchBrands()	GET /v1/vinted/brands	Search brands
vintedSearchVintedItems()	GET /v1/vinted/search	Search Vinted items
vintedVintedScraperHealthCheck()	GET /v1/vinted/health	Vinted scraper health check
vintedVintedScraperHealthCheckHead()	HEAD /v1/vinted/health	Vinted scraper health check

`vintedGetItemDetails()`

vintedGetItemDetails($item_id, $market): mixed

Get item details

Get detailed information about a Vinted item.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\VintedApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$item_id = 56; // int
$market = 'fr'; // string

try {
    $result = $apiInstance->vintedGetItemDetails($item_id, $market);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VintedApi->vintedGetItemDetails: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
item_id	int
market	string		[optional] [default to 'fr']

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`vintedGetUserProfile()`

vintedGetUserProfile($user_id, $market): mixed

Get user profile

Get a Vinted user's profile.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\VintedApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$user_id = 56; // int
$market = 'fr'; // string

try {
    $result = $apiInstance->vintedGetUserProfile($user_id, $market);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VintedApi->vintedGetUserProfile: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
user_id	int
market	string		[optional] [default to 'fr']

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`vintedGetUserSListedItems()`

vintedGetUserSListedItems($user_id, $market, $page, $per_page): mixed

Get user's listed items

Get items listed by a Vinted user.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\VintedApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$user_id = 56; // int
$market = 'fr'; // string
$page = 1; // int
$per_page = 20; // int

try {
    $result = $apiInstance->vintedGetUserSListedItems($user_id, $market, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VintedApi->vintedGetUserSListedItems: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
user_id	int
market	string	[optional] [default to 'fr']
page	int	[optional] [default to 1]
per_page	int	[optional] [default to 20]

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`vintedListColors()`

vintedListColors($market): mixed

List colors

Get available Vinted colors for filtering.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\VintedApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$market = 'fr'; // string

try {
    $result = $apiInstance->vintedListColors($market);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VintedApi->vintedListColors: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
market	string		[optional] [default to 'fr']

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`vintedListItemConditions()`

vintedListItemConditions($market): mixed

List item conditions

Get available item condition statuses.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\VintedApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$market = 'fr'; // string

try {
    $result = $apiInstance->vintedListItemConditions($market);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VintedApi->vintedListItemConditions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
market	string		[optional] [default to 'fr']

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`vintedListMarkets()`

vintedListMarkets(): mixed

List markets

List all supported Vinted markets.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\VintedApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->vintedListMarkets();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VintedApi->vintedListMarkets: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`vintedSearchBrands()`

vintedSearchBrands($keyword, $market): mixed

Search brands

Search Vinted brands.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\VintedApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$keyword = 'keyword_example'; // string | Brand search keyword
$market = 'fr'; // string

try {
    $result = $apiInstance->vintedSearchBrands($keyword, $market);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VintedApi->vintedSearchBrands: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
keyword	string	Brand search keyword
market	string		[optional] [default to 'fr']

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`vintedSearchVintedItems()`

vintedSearchVintedItems($query, $market, $seller_country, $page, $per_page, $price_from, $price_to, $brand_ids, $catalog_ids, $color_ids, $status_ids, $order): mixed

Search Vinted items

Search Vinted catalog items with filters.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\VintedApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$query = 'query_example'; // string | Search text
$market = 'fr'; // string | Market code
$seller_country = 'seller_country_example'; // string | Filter to items whose seller is physically located in one of these comma-separated ISO-2 country codes (e.g. 'fr' or 'fr,be'). Market domains federate cross-border EU listings and Vinted has no native country filter, so each item is enriched with its seller's country and non-matching ones are dropped. Adds 1 credit per uncached seller looked up (cached for 7 days).
$page = 1; // int
$per_page = 20; // int
$price_from = 3.4; // float
$price_to = 3.4; // float
$brand_ids = 'brand_ids_example'; // string
$catalog_ids = 'catalog_ids_example'; // string | Comma-separated Vinted catalog (category) IDs to restrict the search to, e.g. '1904' or '1904,79'. Vinted applies this before searching, so pagination totals reflect the filtered set. A catalog ID is the `catalog[]` value in a Vinted category URL (vinted.fr/catalog?catalog[]=1904).
$color_ids = 'color_ids_example'; // string | Comma-separated color IDs
$status_ids = 'status_ids_example'; // string | Comma-separated condition/status IDs
$order = 'order_example'; // string

try {
    $result = $apiInstance->vintedSearchVintedItems($query, $market, $seller_country, $page, $per_page, $price_from, $price_to, $brand_ids, $catalog_ids, $color_ids, $status_ids, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VintedApi->vintedSearchVintedItems: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
query	string	Search text
market	string	Market code	[optional] [default to 'fr']
seller_country	string	Filter to items whose seller is physically located in one of these comma-separated ISO-2 country codes (e.g. 'fr' or 'fr,be'). Market domains federate cross-border EU listings and Vinted has no native country filter, so each item is enriched with its seller's country and non-matching ones are dropped. Adds 1 credit per uncached seller looked up (cached for 7 days).	[optional]
page	int		[optional] [default to 1]
per_page	int		[optional] [default to 20]
price_from	float		[optional]
price_to	float		[optional]
brand_ids	string		[optional]
catalog_ids	string	Comma-separated Vinted catalog (category) IDs to restrict the search to, e.g. '1904' or '1904,79'. Vinted applies this before searching, so pagination totals reflect the filtered set. A catalog ID is the `catalog[]` value in a Vinted category URL (vinted.fr/catalog?catalog[]=1904).	[optional]
color_ids	string	Comma-separated color IDs	[optional]
status_ids	string	Comma-separated condition/status IDs	[optional]
order	string		[optional]

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`vintedVintedScraperHealthCheck()`

vintedVintedScraperHealthCheck(): mixed

Vinted scraper health check

Check health of the Vinted scraper service. Accepts HEAD so external uptime checkers (UptimeRobot uses HEAD by default for HTTP monitors) don't get a 405 Method Not Allowed.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\VintedApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->vintedVintedScraperHealthCheck();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VintedApi->vintedVintedScraperHealthCheck: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`vintedVintedScraperHealthCheckHead()`

vintedVintedScraperHealthCheckHead(): mixed

Vinted scraper health check

Check health of the Vinted scraper service. Accepts HEAD so external uptime checkers (UptimeRobot uses HEAD by default for HTTP monitors) don't get a 405 Method Not Allowed.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\VintedApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->vintedVintedScraperHealthCheckHead();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VintedApi->vintedVintedScraperHealthCheckHead: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

VintedApi.md

Latest commit

History

VintedApi.md

File metadata and controls

ScrapeBadger\VintedApi

vintedGetItemDetails()

Example

Parameters

Return type

Authorization

HTTP request headers

vintedGetUserProfile()

Example

Parameters

Return type

Authorization

HTTP request headers

vintedGetUserSListedItems()

Example

Parameters

Return type

Authorization

HTTP request headers

vintedListColors()

Example

Parameters

Return type

Authorization

HTTP request headers

vintedListItemConditions()

Example

Parameters

Return type

Authorization

HTTP request headers

vintedListMarkets()

Example

Parameters

Return type

Authorization

HTTP request headers

vintedSearchBrands()

Example

Parameters

Return type

Authorization

HTTP request headers

vintedSearchVintedItems()

Example

Parameters

Return type

Authorization

HTTP request headers

vintedVintedScraperHealthCheck()

Example

Parameters

Return type

Authorization

HTTP request headers

vintedVintedScraperHealthCheckHead()

Example

Parameters

Return type

Authorization

HTTP request headers

`vintedGetItemDetails()`

`vintedGetUserProfile()`

`vintedGetUserSListedItems()`

`vintedListColors()`

`vintedListItemConditions()`

`vintedListMarkets()`

`vintedSearchBrands()`

`vintedSearchVintedItems()`

`vintedVintedScraperHealthCheck()`

`vintedVintedScraperHealthCheckHead()`