Product Catalog API

v2alpha1

Introduction

The Product Catalog API provides methods to retrieve Scaleway's catalog of products and features.

Quickstart

Note

This API does not require authentication to be used.

Run the request below to list all available Scaleway products:

curl -X GET "https://api.scaleway.com/product-catalog/v2alpha1/public-catalog/products?page_size=5"

You can add the following parameters to your endpoint:

Parameter	Description
`page`	Number of the page. Value must be greater or equal to 1.
`page_size`	The number of products per page. Value must be greater or equal to 1.

In the example above, we specify a page_size of 5 products per page.

If the request was successful you will see a response like the following:

{
  "products": [
    {
      "sku": "/compute/pop2_hc_2c_4g/run_fr-par-2",
      "service_category": "Compute",
      "product": "POP2-HC-2C-4G Instance",
      "variant": "Compute POP2-HC-2C-4G Instance - fr-par-2",
      "description": "Compute POP2-HC-2C-4G Instance - fr-par-2 (0.0532€ per hour)",
      "locality": {
        "zone": "fr-par-2"
      },
      "price": {
        "retail_price": {
          "currency_code": "EUR",
          "units": 0,
          "nanos": 53200000
        }
      },
      "properties": {
        "hardware": {
          "cpu": {
            "description": "AMD EPYC™ 7543 (2.8 GHz), x64, vCPUs: 2",
            "arch": "x64",
            "type": "AMD EPYC™ 7543 (2.8 GHz)",
            "virtual": {
              "count": 2
            },
            "threads": 2
          },
          "ram": {
            "description": "4 GiB",
            "size": 4294967296,
            "type": ""
          },
          "storage": {
            "description": "Block",
            "total": 0
          },
          "network": {
            "description": "Internal: 400 Mb/s, Public: 400 Mb/s",
            "internal_bandwidth": 400000000,
            "public_bandwidth": 400000000,
            "max_public_bandwidth": 400000000
          }
        },
        "instance": {
          "range": "Workload-Optimized"
        }
      },
      "environmental_impact_estimation": {
        "kg_co2_equivalent": 0.00080852455,
        "m3_water_usage": 1.9658212e-7
      },
      "unit_of_measure": {
        "unit": "hour",
        "size": 1
      }
    },
    {
      "sku": "/apple-silicon/m4-s/run_par1",
      "service_category": "Bare Metal",
      "product": "Mac Mini M4 - S",
      "variant": "Mac Mini M4 - S - Hourly - fr-par-1",
      "description": "Mac Mini M4 - S - Hourly - fr-par-1 (0.22€ per hour)",
      "locality": {
        "zone": "fr-par-1"
      },
      "price": {
        "retail_price": {
          "currency_code": "EUR",
          "units": 0,
          "nanos": 220000000
        }
      },
      "properties": {
        "hardware": {
          "cpu": {
            "description": "Apple M4, apple_silicon, Sockets: 1, Cores per socket: 10, Threads per core: 1, Frequency: 4.4 GHz",
            "arch": "apple_silicon",
            "type": "Apple M4",
            "physical": {
              "sockets": 1,
              "cores_per_socket": 10,
              "threads_per_core": 1,
              "frequency": 4400000000,
              "benchmark": 0
            },
            "threads": 10
          },
          "ram": {
            "description": "16 GiB LPDDR5X",
            "size": 17179869184,
            "type": "LPDDR5X"
          },
          "storage": {
            "description": "Fixed local: 1 x 256 GB SSD",
            "total": 256000000000
          },
          "network": {
            "description": "Internal: 1 Gb/s, Public: 1 Gb/s",
            "internal_bandwidth": 1000000000,
            "public_bandwidth": 1000000000,
            "max_public_bandwidth": 1000000000
          },
          "gpu": {
            "description": "10 x Apple M4",
            "count": 10,
            "type": "Apple M4"
          }
        },
        "apple_silicon": {
          "range": "M4"
        }
      },
      "environmental_impact_estimation": {
        "kg_co2_equivalent": 0.012052304,
        "m3_water_usage": 0.0000010851885
      },
      "unit_of_measure": {
        "unit": "hour",
        "size": 1
      }
    },
    {
      "sku": "/storage/block/ssd/storage/fr-par1",
      "service_category": "Storage",
      "product": "Performance Block storage - SSD",
      "variant": "Block Storage - fr-par-1",
      "description": "Block Storage - fr-par-1 (0.000118€ per GB)",
      "locality": {
        "zone": "fr-par-1"
      },
      "price": {
        "retail_price": {
          "currency_code": "EUR",
          "units": 0,
          "nanos": 118000
        }
      },
      "unit_of_measure": {
        "unit": "gigabyte",
        "size": 1
      }
    },
    {
      "sku": "/network/domain/domains/fr/register",
      "service_category": "Network",
      "product": "Domain Register",
      "variant": "Domains - Register .fr",
      "description": "Domains - Register .fr (5.99€ per year)",
      "locality": {
        "global": true
      },
      "price": {
        "retail_price": {
          "currency_code": "EUR",
          "units": 5,
          "nanos": 990000000
        }
      },
      "unit_of_measure": {
        "unit": "year",
        "size": 1
      }
    }
  ]
}

The response show you the total number of products in the catalog, and provides you with the following information about each product:

Note

The information displayed in the response varies according to the product. Not all elements listed below apply to every product.

Basic information - product name, description, category
Locality - availability per region or zone, or global
Price - retail price of each product
Additional information - hardware specifications, ranges

Tip

Refer to the response description of the List all available products method to find an extensive list of all possible response attributes.

Requirements

To perform the following steps, you must first ensure that:

you have installed curl

Product catalog

Scaleway's Product Catalog is an extensive list of the Scaleway products. The catalog includes details about each product including: description, locations, prices and properties.

GET/product-catalog/v2alpha1/public-catalog/products