Query parameters

• locale string

  Descriptions of products can be localized.

  Minimum length is 2, maximum length is 5. Format should match the following pattern: ^(?:[a-z]{2}|[a-z]{2}-[A-Z]{2})$. Values are de, en, es, fr, hi, it, ja, pt, pt-BR, or zh-CN. Default value is en.

• page number

  An optional parameter that enables pagination, by default the amount of items per page is 25

  Minimum value is 1.

• items number

  An optional parameter that enables pagination, this controls the amount of items per page. Can be used separetly or in conjunction with page

  Minimum value is 1, maximum value is 25.

• category string

  Allows filtering of the categories of a product, filters by code

• class string

  Allows filtering of the classes of a product, filters by code

• impact_type string

  Allows filtering of the impact types of a product, filters by code

Responses

• 200 application/json

  OK

  Hide headers attribute Show headers attribute

  • SQUAKE-Request-Id

    Unique identifier linked to this API request. If you need to contact us regarding a specific request, providing the request identifier helps the resolution process.

  Hide response attributes Show response attributes object

  • id string Required

    Format should match the following pattern: product_[A-Za-z0-9]*.

  • locations array[object]

    List of all locations impacted by the projects used in this product.

    Information on a location according to ISO 3166 or UN M49. This can be, for example, a country code such as DE for Germany (using alpha2), or a sub region code such as 155 for Western Europe, or region code such as 150 for Europe.

    Hide locations attributes Show locations attributes object

    • country string Required

      Two-letter or three-letter code as defined in ISO 3166-1 alpha-2 and alpha-3 respectively.

      Minimum length is 2, maximum length is 3. Format should match the following pattern: ^[A-Z]{2,3}$.

    • sub_region string

      One to Three-digit UN M49 sub region code.

    • region string

      One to Three-digit UN M49 region code.

  • certifications array[string]

    List of all certifications the projects for this product hold.

    Values are American Carbon Registry, Australian Biodiversity Unit, BAFU VER, Clean Development Mechanism, DNV, Ernst & Young, European Biochar Certification, Gold Standard CER, Gold Standard VER, I-REC, International Sustainability & Carbon Certification (ISCC), ISO 14064, Moor Futures, Müller BBM, Plan Vivo, TÜV, or Verified Carbon Standard.

  • title string

    A short human readable summary of the description.

  • description string

    A human readable description.

  • sdgs array[integer]

    The Sustainable Development Goals (SDGs) aim to transform our world. They are a call to action to end poverty and inequality, protect the planet, and ensure that all people enjoy health, justice and prosperity.

    Minimum value of each is 1, maximum value of each is 17.

  • files array[object]

    Images attached to the product.

    Hide files attributes Show files attributes object

    • id string Required

      Format should match the following pattern: file_[A-Za-z0-9]*.

    • filename string Required
    • purpose string Required

      Values are confirmation_document, certificate_document, or project_image.

    • size integer Required

      Byte size of the object

    • type string Required

      Values are csv, jpg, pdf, png, or webp.

    • download_url string(uri)

      The link will expire after 1 year. If blank, the document has not been created yet. Please poll until a link is included.

    • notification string

      Information pertaining to the file, e.g., when the file will be available

  • prices array[object]

    Multiple prices may exist, for example, when future price changes are already known.

    For carbon compensation products, prices define the unit cost (per unit, e.g., "tonne"). Prices are valid for a given period as the market fluctuates.

    Typically there is one currently valid price for a product. As the market fluctuates, prices can change; usually, SQUAKE is informed by their project partners of future price changes; hence multiple prices can be returned for the same product.

    This endpoint returns only valid prices. These are purley informational; for interacting with the API, products must be passed.

    Hide prices attributes Show prices attributes object

    • id string Required

      Format should match the following pattern: price_[A-Za-z0-9]*.

    • product string Required
    • unit_amount integer(int64) Required

      The total amount in the lower denomination of the currency; e.g. 12.34 USD would be 1234.

    • carbon_unit string Required

      SQUAKE uses The International System of Units (SI), commonly referred to as "metric system".

      Values are tonne, kilogram, or gram.

    • currency string Required

      3-letter ISO 4217 alpha code of the currency.

      Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z]{3}$. Values are AED, AMD, ARS, AUD, AZN, BAM, BGN, BHD, BRL, CAD, CHF, CLP, CNY, COP, CRC, CZK, DKK, DZD, EGP, ETB, EUR, GBP, GEL, HKD, HUF, IDR, INR, ISK, JMD, JOD, JPY, KES, KRW, KWD, KZT, LKR, LYD, MAD, MUR, MXN, MYR, NOK, NZD, OMR, PHP, PKR, PLN, QAR, RSD, RUB, SAR, SEK, SGD, SYP, THB, TND, TRY, TTD, TWD, UAH, USD, VND, XAF, XOF, or ZAR. Default value is EUR.

    • valid_from string(date) Required

      Date in ISO 8601 notation.

      Format should match the following pattern: ^\d{4}-\d{2}-\d{2}$.

  • categories array[object]
    Hide categories attributes Show categories attributes object

    • code string Required

      Unique identifier for a category

      Format should match the following pattern: ^[a-z_]+$.

    • title string

      English human-readable name of the category.

  • impact_types array[object]
    Hide impact_types attributes Show impact_types attributes object

    • code string Required

      Unique identifier for a impact type

      Format should match the following pattern: ^[a-z_]+$.

    • title string

      English human-readable name of the impact type

  • classes array[object]
    Hide classes attributes Show classes attributes object

    • code string Required

      Unique identifier for a project class

      Format should match the following pattern: ^[a-z_]+$.

    • title string

      English human-readable name of the project class

• 401 application/json

  Example response

  Hide headers attribute Show headers attribute

  • SQUAKE-Request-Id

    Unique identifier linked to this API request. If you need to contact us regarding a specific request, providing the request identifier helps the resolution process.

  Hide response attributes Show response attributes object

  • code string Required

    An application-specific error code, expressed as a string value.

    Values are field_validation_error, server_error, not_authorized, not_found, invalid_methodology, or invalid_type.

  • detail string

    A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized.

  • source object
    Hide source attributes Show source attributes object

    • id string
    • attribute string Required
    • model string