/ws-api-client-python

Wheel Fitment API Client SDK for Python

Primary LanguagePython

ws-api-client-python

The Wheel Fitment API allows for programmatic access to the database of www.wheel-size.com and its services. Use this API to retrieve information about vehicle fitment database for rims and tires, including OE and option fitments, and plus/minus sizing fitment information. A variety of country and language specific options are available. The coverage of fitment data for vehicles manufactured since 2000 is nearly 100%. The information about fitment data is updated on a daily basis.

This Python package is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

pip install git+https://github.com/driveate/ws-api-client-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/driveate/ws-api-client-python.git)

Then import the package:

import ws_api_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import ws_api_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import ws_api_client
from ws_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: user_key
ws_api_client.configuration.default_config.api_key['user_key'] = 'YOUR_API_KEY'
# create an instance of the API class
api_instance = ws_api_client.MakesApi()
countries = 'us,gb,jp' # str | Show information for local manufacturers from specified countries only. Use `GET /countries/` method to get the full list of countries. (e.g. `us,gb,jp`) (optional)
try:
    # Get list of manufacturers
    api_response = api_instance.makes_list(countries=countries)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MakesApi->makes_list: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.wheel-size.com/v1

Class Method HTTP request Description
BoltPatternsApi bolt_patterns_list GET /bolt-patterns/ Get list of bolt patterns
BoltPatternsApi bolt_patterns_read GET /bolt-patterns/{bolt_pattern}/ Model modifications by bolt pattern
CountriesApi countries_list GET /countries/ Returns a list of countries
GenerationsApi generations_list GET /generations/ Generations for the given model
MakesApi makes_list GET /makes/ Returns a list of manufacturers
MarketsApi markets_list GET /markets/ Returns a list of markets/regions
ModelsApi models_list GET /models/ Returns a list of models by manufacturer
ModelsApi models_read GET /models/{make}/{slug}/ Get more info about model
ModelsApi models_read_year GET /models/{make}/{slug}/{year}/ Get more info about model/year
SearchApi search_by_hf_tire_list GET /search/by_hf_tire/ Find models matching given high flotation tire
SearchApi search_by_model_list GET /search/by_model/ Find OE and option fitments by model/year/trim
SearchApi search_by_rim_list GET /search/by_rim/ Find models matching given rim parameters
SearchApi search_by_tire_list GET /search/by_tire/ Find models matching given tire parameters
TiresApi tires_list GET /tires/ Returns a list of tires
TiresApi tires_read GET /tires/{tire}/ Model modifications matching given tire
TrimsApi trims_list GET /trims/ Model modifications
VehiclesApi vehicles_list GET /vehicles/ Find OE and option fitments by model/year/trim
YearsApi years_list GET /years/ Returns list of years for the given manufacturer/model

Documentation For Models

Documentation For Authorization

user_key

  • Type: API key
  • API key parameter name: user_key
  • Location: URL query string

Author

info@wheel-size.com