Skip to content

VintedApi.md

Latest commit

 

History

History
766 lines (553 loc) · 20.9 KB

VintedApi.md

File metadata and controls

766 lines (553 loc) · 20.9 KB
Raw

ScrapeBadger::VintedApi

All URIs are relative to https://scrapebadger.com

Method HTTP request Description
vinted_get_item_details GET /v1/vinted/items/{item_id} Get item details
vinted_get_user_profile GET /v1/vinted/users/{user_id} Get user profile
vinted_get_user_s_listed_items GET /v1/vinted/users/{user_id}/items Get user's listed items
vinted_list_colors GET /v1/vinted/colors List colors
vinted_list_item_conditions GET /v1/vinted/statuses List item conditions
vinted_list_markets GET /v1/vinted/markets List markets
vinted_search_brands GET /v1/vinted/brands Search brands
vinted_search_vinted_items GET /v1/vinted/search Search Vinted items
vinted_vinted_scraper_health_check GET /v1/vinted/health Vinted scraper health check
vinted_vinted_scraper_health_check_head HEAD /v1/vinted/health Vinted scraper health check

vinted_get_item_details

Object vinted_get_item_details(item_id, opts)

Get item details

Get detailed information about a Vinted item.

Examples

require 'time'
require 'scrapebadger'
# setup authorization
ScrapeBadger.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['X-API-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-API-Key'] = 'Bearer'
end

api_instance = ScrapeBadger::VintedApi.new
item_id = 56 # Integer | 
opts = {
  market: 'market_example' # String | 
}

begin
  # Get item details
  result = api_instance.vinted_get_item_details(item_id, opts)
  p result
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_get_item_details: #{e}"
end

Using the vinted_get_item_details_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Object, Integer, Hash)> vinted_get_item_details_with_http_info(item_id, opts)

begin
  # Get item details
  data, status_code, headers = api_instance.vinted_get_item_details_with_http_info(item_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Object
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_get_item_details_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
item_id Integer
market String [optional][default to 'fr']

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

vinted_get_user_profile

Object vinted_get_user_profile(user_id, opts)

Get user profile

Get a Vinted user's profile.

Examples

require 'time'
require 'scrapebadger'
# setup authorization
ScrapeBadger.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['X-API-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-API-Key'] = 'Bearer'
end

api_instance = ScrapeBadger::VintedApi.new
user_id = 56 # Integer | 
opts = {
  market: 'market_example' # String | 
}

begin
  # Get user profile
  result = api_instance.vinted_get_user_profile(user_id, opts)
  p result
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_get_user_profile: #{e}"
end

Using the vinted_get_user_profile_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Object, Integer, Hash)> vinted_get_user_profile_with_http_info(user_id, opts)

begin
  # Get user profile
  data, status_code, headers = api_instance.vinted_get_user_profile_with_http_info(user_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Object
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_get_user_profile_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
user_id Integer
market String [optional][default to 'fr']

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

vinted_get_user_s_listed_items

Object vinted_get_user_s_listed_items(user_id, opts)

Get user's listed items

Get items listed by a Vinted user.

Examples

require 'time'
require 'scrapebadger'
# setup authorization
ScrapeBadger.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['X-API-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-API-Key'] = 'Bearer'
end

api_instance = ScrapeBadger::VintedApi.new
user_id = 56 # Integer | 
opts = {
  market: 'market_example', # String | 
  page: 56, # Integer | 
  per_page: 56 # Integer | 
}

begin
  # Get user's listed items
  result = api_instance.vinted_get_user_s_listed_items(user_id, opts)
  p result
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_get_user_s_listed_items: #{e}"
end

Using the vinted_get_user_s_listed_items_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Object, Integer, Hash)> vinted_get_user_s_listed_items_with_http_info(user_id, opts)

begin
  # Get user's listed items
  data, status_code, headers = api_instance.vinted_get_user_s_listed_items_with_http_info(user_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Object
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_get_user_s_listed_items_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
user_id Integer
market String [optional][default to 'fr']
page Integer [optional][default to 1]
per_page Integer [optional][default to 20]

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

vinted_list_colors

Object vinted_list_colors(opts)

List colors

Get available Vinted colors for filtering.

Examples

require 'time'
require 'scrapebadger'
# setup authorization
ScrapeBadger.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['X-API-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-API-Key'] = 'Bearer'
end

api_instance = ScrapeBadger::VintedApi.new
opts = {
  market: 'market_example' # String | 
}

begin
  # List colors
  result = api_instance.vinted_list_colors(opts)
  p result
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_list_colors: #{e}"
end

Using the vinted_list_colors_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Object, Integer, Hash)> vinted_list_colors_with_http_info(opts)

begin
  # List colors
  data, status_code, headers = api_instance.vinted_list_colors_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Object
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_list_colors_with_http_info: #{e}"
end

Parameters

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

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

vinted_list_item_conditions

Object vinted_list_item_conditions(opts)

List item conditions

Get available item condition statuses.

Examples

require 'time'
require 'scrapebadger'
# setup authorization
ScrapeBadger.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['X-API-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-API-Key'] = 'Bearer'
end

api_instance = ScrapeBadger::VintedApi.new
opts = {
  market: 'market_example' # String | 
}

begin
  # List item conditions
  result = api_instance.vinted_list_item_conditions(opts)
  p result
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_list_item_conditions: #{e}"
end

Using the vinted_list_item_conditions_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Object, Integer, Hash)> vinted_list_item_conditions_with_http_info(opts)

begin
  # List item conditions
  data, status_code, headers = api_instance.vinted_list_item_conditions_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Object
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_list_item_conditions_with_http_info: #{e}"
end

Parameters

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

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

vinted_list_markets

Object vinted_list_markets

List markets

List all supported Vinted markets.

Examples

require 'time'
require 'scrapebadger'
# setup authorization
ScrapeBadger.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['X-API-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-API-Key'] = 'Bearer'
end

api_instance = ScrapeBadger::VintedApi.new

begin
  # List markets
  result = api_instance.vinted_list_markets
  p result
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_list_markets: #{e}"
end

Using the vinted_list_markets_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Object, Integer, Hash)> vinted_list_markets_with_http_info

begin
  # List markets
  data, status_code, headers = api_instance.vinted_list_markets_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Object
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_list_markets_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

vinted_search_brands

Object vinted_search_brands(keyword, opts)

Search brands

Search Vinted brands.

Examples

require 'time'
require 'scrapebadger'
# setup authorization
ScrapeBadger.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['X-API-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-API-Key'] = 'Bearer'
end

api_instance = ScrapeBadger::VintedApi.new
keyword = 'keyword_example' # String | Brand search keyword
opts = {
  market: 'market_example' # String | 
}

begin
  # Search brands
  result = api_instance.vinted_search_brands(keyword, opts)
  p result
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_search_brands: #{e}"
end

Using the vinted_search_brands_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Object, Integer, Hash)> vinted_search_brands_with_http_info(keyword, opts)

begin
  # Search brands
  data, status_code, headers = api_instance.vinted_search_brands_with_http_info(keyword, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Object
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_search_brands_with_http_info: #{e}"
end

Parameters

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

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

vinted_search_vinted_items

Object vinted_search_vinted_items(query, opts)

Search Vinted items

Search Vinted catalog items with filters.

Examples

require 'time'
require 'scrapebadger'
# setup authorization
ScrapeBadger.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['X-API-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-API-Key'] = 'Bearer'
end

api_instance = ScrapeBadger::VintedApi.new
query = 'query_example' # String | Search text
opts = {
  market: 'market_example', # 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: 56, # Integer | 
  per_page: 56, # Integer | 
  price_from: 8.14, # Float | 
  price_to: 8.14, # 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 | 
}

begin
  # Search Vinted items
  result = api_instance.vinted_search_vinted_items(query, opts)
  p result
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_search_vinted_items: #{e}"
end

Using the vinted_search_vinted_items_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Object, Integer, Hash)> vinted_search_vinted_items_with_http_info(query, opts)

begin
  # Search Vinted items
  data, status_code, headers = api_instance.vinted_search_vinted_items_with_http_info(query, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Object
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_search_vinted_items_with_http_info: #{e}"
end

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 Integer [optional][default to 1]
per_page Integer [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

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

vinted_vinted_scraper_health_check

Object vinted_vinted_scraper_health_check

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.

Examples

require 'time'
require 'scrapebadger'
# setup authorization
ScrapeBadger.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['X-API-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-API-Key'] = 'Bearer'
end

api_instance = ScrapeBadger::VintedApi.new

begin
  # Vinted scraper health check
  result = api_instance.vinted_vinted_scraper_health_check
  p result
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_vinted_scraper_health_check: #{e}"
end

Using the vinted_vinted_scraper_health_check_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Object, Integer, Hash)> vinted_vinted_scraper_health_check_with_http_info

begin
  # Vinted scraper health check
  data, status_code, headers = api_instance.vinted_vinted_scraper_health_check_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Object
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_vinted_scraper_health_check_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

vinted_vinted_scraper_health_check_head

Object vinted_vinted_scraper_health_check_head

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.

Examples

require 'time'
require 'scrapebadger'
# setup authorization
ScrapeBadger.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['X-API-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['X-API-Key'] = 'Bearer'
end

api_instance = ScrapeBadger::VintedApi.new

begin
  # Vinted scraper health check
  result = api_instance.vinted_vinted_scraper_health_check_head
  p result
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_vinted_scraper_health_check_head: #{e}"
end

Using the vinted_vinted_scraper_health_check_head_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Object, Integer, Hash)> vinted_vinted_scraper_health_check_head_with_http_info

begin
  # Vinted scraper health check
  data, status_code, headers = api_instance.vinted_vinted_scraper_health_check_head_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Object
rescue ScrapeBadger::ApiError => e
  puts "Error when calling VintedApi->vinted_vinted_scraper_health_check_head_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json