Lune Emission factors API

openapi: 3.2.0
info:
  title: Lune Emission factors API
  version: '1.0'
  contact:
    name: Lune Support
    email: support@lune.co
  termsOfService: https://lune.co/terms
  description: 'Operations tagged Emission factors across 2 of this provider''s published API definitions: openapi.yml, lune-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.lune.co/v1
  description: Lune's REST API
tags:
- name: Emission factors
  description: An emission factor is a coefficient which allows to convert activity data into GHG emissions.
  x-lune-component: EmissionFactor
paths:
  /emission-factors:
    get:
      tags:
      - Emission factors
      summary: List emission factors
      operationId: listEmissionFactors
      parameters:
      - $ref: '#/components/parameters/LimitPagination'
      - $ref: '#/components/parameters/AfterPagination'
      - name: name
        in: query
        description: 'Search for emission factors (case insensitive). A combination of semantic and keyword search

          is used to provide the most relevant results.

          '
        schema:
          type: string
          example: pipe
        allowReserved: true
      - name: source
        in: query
        description: 'Filter emission factors based on source.

          When omitted, all sources are returned.

          '
        schema:
          type: array
          items:
            $ref: '#/components/schemas/EmissionFactorSource'
          example:
          - GLEC
      - name: publication_year
        in: query
        description: Filter emission factors based on the publication year.
        schema:
          type: array
          items:
            type: number
            example: 2021
      - name: region
        in: query
        description: 'Filter emission factors based on region (case insensitive).

          When omitted, all regions are returned.


          The `region_fallback` parameter controls how `region` is interpreted, by default

          an exact match is required.


          Countries are included in regions but there are also broader geographic regions like Europe or Asia.

          '
        schema:
          type: array
          items:
            type: string
            example: Europe
        allowReserved: true
      - name: region_fallback
        in: query
        description: "Controls how `region` is interpreted and if region fallback is performed.\n\nRegion fallback is looking up emission factors for regions related to the specified\nregions.\n\n* `never` (the default) means no region fallback is performed and only emission\n  factors that match the specified region(s) are returned.\n* `always` means the emission factors for related regions are unconditionally included\n  in the results.\n"
        schema:
          type: string
          enum:
          - never
          - always
      - name: unit
        in: query
        description: 'Filter emission factors based on the logical unit.

          When omitted, all units are returned.

          '
        schema:
          $ref: '#/components/schemas/EmissionFactorLogicalUnit'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEmissionFactors'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    servers:
    - url: https://api.lune.co/v1
      description: Lune's REST API
  /emission-factors/regions:
    get:
      tags:
      - Emission factors
      summary: List all emission factor regions
      description: You may use emission factor regions as a filter when you list emission factors.
      operationId: listAllEmissionFactorRegions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmissionFactorRegions'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
    servers:
    - url: https://api.lune.co/v1
      description: Lune's REST API
components:
  schemas:
    Error:
      type: object
      description: Individual error information
      required:
      - error_code
      - message
      properties:
        error_code:
          type: string
          description: Immutable string representing a specific error.
          example: account_suspended
          enum:
          - api_version_invalid
          - account_suspended
          - bundle_selection_ratios_invalid
          - bundle_selection_bundle_invalid
          - order_idempotency_already_exists
          - order_quantity_invalid
          - order_value_invalid
          - bundle_id_invalid
          - id_invalid
          - distance_invalid
          - test_account_name_update_disallowed
          - validation_error
          - bundle_selection_ratios_invalid_format
          - address_not_found
          - port_not_found
          - locode_not_found
          - airport_invalid
          - webhook_limit_reached
          - time_range_invalid
          - exchange_rate_not_found
          - live_account_required
          - unauthorised
          - estimate_not_found
          - estimate_order_already_placed
          - sustainability_page_slug_not_unique
          - sustainability_page_exists
          - pagination_limit_invalid
          - unsupported_image_format
          - source_location_code_invalid
          - destination_location_code_invalid
          - emission_factor_id_invalid
          - emission_factor_unit_mismatch
          - emission_factor_gated
          - account_scope_incorrect
          - service_unavailable
          - handle_not_unique
          - estimate_idempotency_already_exists
          - airport_route_required
          - future_departure_invalid
          - transaction_document_inference_failure
          - transaction_document_creation_failure
          - invalid_selected_account_id
          - account_idempotency_already_exists
          - account_handle_idempotency_key_inconsistency
          - shipment_batch_idempotency_already_exists
          - route_not_found
          - insufficient_credits
          - client_account_mismatch
        message:
          type: string
          description: 'Human readable error message.


            This value can contain some extra information about the error in

            human-readable form. Not suitable for programmatic consumption, the format

            is not guaranteed to be stable.

            '
    EmissionFactorSource:
      type: string
      enum:
      - epa
      - exiobase
      - ecoinvent
      - beis
      - lune
      - glec
      - emsa
      - cbam
      - ademe
      - idemat
      - iata
      - ember
      - ceda
      - icct
      example: exiobase
    DistanceUnit:
      x-lune-name: Distance
      type: string
      enum:
      - m
      - km
      - mi
      - nm
      example: km
      description: Distance unit, `km` for kilometers, `mi` for miles and `nm` for nautical miles
    PaginatedEmissionFactors:
      allOf:
      - $ref: '#/components/schemas/PaginatedBase'
      - type: object
        required:
        - data
        properties:
          data:
            type: array
            description: 'An array of Emission Factor objects, ordered by best match.


              Part of a paginated response.

              '
            items:
              $ref: '#/components/schemas/EmissionFactor'
    MassUnit:
      x-lune-name: Mass
      type: string
      description: Unit, `t` for tonne, `kg` for kilogram, `g` for gram, `lbs` for pound
      enum:
      - g
      - kg
      - t
      - lbs
      example: t
    EmissionFactorLogicalUnit:
      type: string
      enum:
      - currency
      - distance
      - item
      - time
      - area
      - volume
      - energy
      - mass
      - person-time
      - person-distance
      - mass-time
      - mass-distance
      - distance-time
      - area-time
      - room-time
      example: currency
    EmissionFactorDenominatorUnit:
      oneOf:
      - $ref: '#/components/schemas/CurrencyCode'
      - $ref: '#/components/schemas/DistanceUnit'
      - type: string
        x-lune-name: Other units
        enum:
        - item
        - MJ
        - GJ
        - guest*night
        - room*night
        - ha
        - hour
        - seconds
        - kWh
        - kWh ICV
        - kWh LHV
        - kWh HHV
        - kWh SCV
        - toe
        - toe ICV
        - toe HHV
        - toe SCV
        - GJ ICV
        - GJ HHV
        - GJ SCV
        - MJ ICV
        - kg
        - kg*day
        - km*year
        - l
        - Ml
        - ml
        - m*year
        - cm2
        - m2
        - ha*year
        - m2*year
        - m3
        - m3*km
        - t*km
        - person*km
        - person*month
        - vehicle*km
        - meal
        - t
        - fte*working_hour
        - TEU
        - TEU*km
        - p
        - A4_sheets
        example: item
    EmissionFactorRegions:
      type: array
      description: 'An array of regions.

        '
      items:
        type: string
        description: The name of the country or region of the emission factor.
      example:
      - United Kingdom
      - IAI Area, South America
      - Europe
    EmissionFactor:
      description: 'An emission factors is a coefficient representing the amount of emissions per unit of activity, eg 0.354kgCO₂/USD.


        The `source` property describes what database the emission factor has been ingested from.

        '
      type: object
      required:
      - id
      - name
      - source
      - source_version
      - publication_year
      - numerator_unit
      - denominator_unit
      - created_at
      - region
      - category
      properties:
        id:
          description: The emission factor unique identifier
          type: string
          example: ljmkOq7vXd238gAE9WALWQ8ZGVD5ExNz
        name:
          description: The emission factor name
          type: string
          example: Steel Pipe
        source:
          $ref: '#/components/schemas/EmissionFactorSource'
        source_version:
          description: Source version of the emission factor.
          type: string
          example: '1.0'
        publication_year:
          description: Publication year of the emission factor
          type: number
          example: 2021
        numerator_unit:
          description: Numerator unit of the emission factor
          $ref: '#/components/schemas/MassUnit'
        denominator_unit:
          description: Denominator unit of the emission factor
          $ref: '#/components/schemas/EmissionFactorDenominatorUnit'
        created_at:
          description: Date of creation of the emission factor
          type: string
          format: date-time
          example: '2022-09-01T00:00:00.000Z'
        region:
          type: string
          description: The name of the region that the emission factor covers.
        category:
          type:
          - string
          - 'null'
          description: A category that describes the emission factor.
    ErrorResponse:
      x-lune-name: Error response
      description: 'An error response containing the error details.


        The `error` property provides information about the type of error that occurred.

        Use this property for error handling.


        The `errors` array is present for backwards compatibility purposes. It always

        contains a single error element which is the same seen in the `error` property.

        '
      type: object
      required:
      - errors
      - error
      properties:
        errors:
          type: array
          description: An array containing errors
          items:
            $ref: '#/components/schemas/Error'
        error:
          $ref: '#/components/schemas/Error'
    PaginatedBase:
      type: object
      required:
      - has_more
      - next_cursor
      properties:
        has_more:
          type: boolean
          description: 'Whether or not there are more elements available after this set.


            If false, this set comprises the end of the array.


            Part of a paginated response.

            '
        next_cursor:
          description: 'The cursor value to be used as the after parameter for fetching the next page of results.


            `null` if `has_more` is `false`.

            '
          type:
          - string
          - 'null'
    CurrencyCode:
      x-lune-name: Currency code
      type: string
      description: 'ISO 4217 3 character currency code.


        Note: Lune supports most but not all currency codes.

        '
      example: GBP
      enum:
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BRL
      - BSD
      - BTC
      - BTN
      - BWP
      - BYN
      - BYR
      - BZD
      - CAD
      - CDF
      - CHF
      - CLF
      - CLP
      - CNY
      - CNH
      - COP
      - CRC
      - CUC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GGP
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HRK
      - HTG
      - HUF
      - IDR
      - ILS
      - IMP
      - INR
      - IQD
      - IRR
      - ISK
      - JEP
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LTL
      - LVL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRU
      - MUR
      - MVR
      - MWK
      - MXN
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SLE
      - SLL
      - SOS
      - SRD
      - STD
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - UYU
      - UZS
      - VES
      - VND
      - VUV
      - WST
      - XAF
      - XAG
      - XAU
      - XCD
      - XDR
      - XOF
      - XPF
      - YER
      - ZAR
      - ZMK
      - ZMW
      - ZWL
  responses:
    BadRequest:
      description: The request is invalid. Parameters may be missing or are invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    TooManyRequests:
      description: Too many requests have been made in a short period of time
    Unauthorized:
      description: The API Key is missing or is invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServiceUnavailable:
      description: The service is temporarily unavailable. You may retry.
  parameters:
    LimitPagination:
      name: limit
      in: query
      required: false
      description: 'Maximum number of resources to return, between 1 and 100.

        '
      schema:
        type: string
        pattern: ^\d+$
        default: '10'
        example: '50'
    AfterPagination:
      name: after
      in: query
      required: false
      description: 'A cursor for use in pagination.


        The cursor that points to the starting item of the next page of results. If not provided, the first page of results is returned.

        '
      schema:
        type: string
        example: 0vE213P96LbXNap56NAqVoM7knOedQg4
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Authorization Bearer API Key (see <a href="#section/Authentication">Authentication</a>)
    AccessToken:
      type: apiKey
      in: query
      name: access_token
      description: 'An API key used to access a resource that accepts it in the URL.


        Note: Lune API keys are not URL-safe, which means that they can''t be included in URLs directly.

        They need to be percent-encoded using a function like JavaScript''s [`encodeURIComponent()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) or

        Python''s [`urllib.parse.quote()`](https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote).

        '
x-refined-from:
- openapi.yml
- lune-openapi.yml