Skip to main content

A unofficial Python wrapper for the Restocks API

Project description

Restocks.net API Wrapper

Overview

The restocks_api_wrapper is an unofficial wrapper for the api of the sneaker platform restocks.net. It allows you to get information about products, but also to manage your sales. There is no connection to restocks, this is a private project.

Installation

Install the package using pip:

pip install restocks-api-wrapper

Ensure that you are using Python 3.11 or higher, as this is the minimum version required for this package.

Functions

Function Name Description Login Required
search_product Searches for a product by SKU or name. No
get_product_info Retrieves detailed information about a product. No
get_size_id Fetches the size ID for a given product and size. No
get_sku_from_id Retrieves the SKU for a product based on its ID. No
get_payout Calculates the expected payout for a listing. No
login Authenticates the user with email and password. No
check_login Checks if the user is logged in. Yes
get_current_listings Retrieves current product listings. Yes
get_history_sales Fetches historical sales data. Yes
get_current_sales Fetches current sales data. Yes
edit_listing Edits the price of an existing listing. Yes
delete_listing Deletes an existing listing. Yes
list_product Lists a new product for sale. Yes
get_shipping_products Retrieves products that need shipping. Yes
download_label Downloads the shipping label for a product. Yes
check_consign_status Checks the consignment status of the user. Yes

Usage Example

from restocks_client.client import RestocksClient
from restocks_client.filters import SellMethod, ListingDuration

# Initialize the RestocksClient with login credentials and proxy list.
client = RestocksClient(
    proxy_list=[
        "proxy1:port:username:password",
        "proxy2:port:username:password",
        # ... (Add more proxies as needed)
    ]
)

# Fetch information about a product using its SKU.
product_info = client.get_product_info(slug=client.search_product(sku='DD1391-100').slug)

# set login data
client.email = 'your_email@example.com',
client.password = 'your_password',

# Authenticate and login.
client.login()

# Retrieve current listings with a specific sell method.
current_listings = client.get_current_listings(sell_method=SellMethod.Resell)

# List a product for sale on the platform.
client.list_product(
    product=client.search_product(sku='DD1391-100'),
    size='36',
    sell_method=SellMethod.Resell,
    duration=ListingDuration.Days90,
    store_price=900
)

# Example of working with listings.
listing = current_listings[1]
client.edit_listing(listing_id=listing.listing_id, new_price=500)

for listing in current_listings:
    client.delete_listing(listing.listing_id)

Note

I recommend the use of proxies, which can be specified as a list as shown in the example. The format hostname:port:username:password is used for this. The use of proxies helps to avoid blocks of restocks. If no proxy list is given, the localhost is used by default.

Credits

This project was inspired by the structure of ssbanjo's Restocks-client. While restocks_api_wrapper is a completely independent and updated implementation, the design and workflow provided a starting point for development. Many thanks to the original author for their work.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

restocks_api_wrapper-0.1.1.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

restocks_api_wrapper-0.1.1-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

Details for the file restocks_api_wrapper-0.1.1.tar.gz.

File metadata

  • Download URL: restocks_api_wrapper-0.1.1.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for restocks_api_wrapper-0.1.1.tar.gz
Algorithm Hash digest
SHA256 a4e639b26c712510710062448386b0c85a2b0aa8c5e8ceeb1c9dd3ad4005b5ba
MD5 9fe831504c6f7dd1704a3ae8b9746622
BLAKE2b-256 5fa43f18377d278453669e331b6bcdbef436c9f20b4878c56b48066075edf680

See more details on using hashes here.

File details

Details for the file restocks_api_wrapper-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for restocks_api_wrapper-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b6bf161ee6377408e885546ede92ee11017290b2ca56c83cbb272d484d3dee1a
MD5 69616f5b64542201a098295c14c894e9
BLAKE2b-256 80b67244078c36f042602d08e97e537c62f08403652dfadeffe3cd83d9cf2efe

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page