API endpoint: root

This is the public Victron API, where you can find all publicly available information about products and related data.
For customer-specific data — such as pricing, stock levels, and more — you'll need access to the E-Order API. We strongly recommend that all distributors use the E-Order API, as it includes everything from the public API along with personalized information.

For technical support using this API you can contact support@ytec.nl.

Formats

You are currently looking at the unformatted version of the API which contains the documentation. In order to retrieve usable data, put the desired format in the querystring as shown in the examples below.

To see the API in action you can use your browser to visit ...

/api/v1/products/?format=xml

... or ...

/api/v1/products/?format=json

... to see the list of products and their details as XMl and JSON respectively.

Retrieving data from the command line (Linux/OSX) using curl (example):

$ curl "https://www.victronenergy.com/api/v1/products?format=json"

Retrieving data from the command line (Linux/OSX) using wget (example):

$ wget "https://www.victronenergy.com/api/v1/products?format=xml"

Localization

Some of the data is available in multiple languages. For the four products endpoints this concerns the fields name, short_name, description and documents-url. For the categories endpoint this concerns the field title.

Available localizations

en_ZA, zh_CN, cs_CZ, da_DK, de_DE, en_AU, en_GB, es_ES, fi_FI, fr_FR, el_GR, hu_HU, it_IT, nl_NL, nn_NO, pl_PL, pt_PT, ro_RO, ro_RO, ru_RU, sl_SI, sv_SE, tr_TR, uk_UA

Localization via the querystring

The endpoints products, product by sku and categories support localization via the querystring. By appending &language=xx_YY to the URL you will retrieve information translated for a specific language / region. If something is not translated in your preferred language you will get the English version.

Localization in one go

The endpoints translated products and translated product by sku show the same data as their counterparts products and product by sku, but include all available translations for the fields that (can) have translations. Missing locales imply that no translation is available for that locale. English values (keyed by en_GB) are always available as fallback.

Available endpoints

• products: /api/v1/products
• product by sku: /api/v1/product/sku/xxx (replace xxx by valid sku)
• translated products: /api/v1/productstranslated
• translated product by sku: /api/v1/producttranslated/sku/xxx (replace xxx by valid sku)
• categories: /api/v1/categories
• document types: /api/v1/documenttypes
• events: /api/v1/events

{
    "products":"https:\/\/www.victronenergy.com\/api\/v1\/products",
    "product by sku":"https:\/\/www.victronenergy.com\/api\/v1\/product\/sku\/xxx",
    "translated products":"https:\/\/www.victronenergy.com\/api\/v1\/productstranslated",
    "translated product by sku":"https:\/\/www.victronenergy.com\/api\/v1\/producttranslated\/sku\/xxx",
    "categories":"https:\/\/www.victronenergy.com\/api\/v1\/categories",
    "documenttypes":"https:\/\/www.victronenergy.com\/api\/v1\/documenttypes",
    "events":"https:\/\/www.victronenergy.com\/api\/v1\/events"
}