Lune Docs Logo

Multi-leg shipments
Sea shipments
AIS vessel tracking
Future shipments by sea
Road shipments
Air shipments
Rail shipments
Road transfer inference
CSV upload
Tender upload
Emissions visibility widget
Integrate with CargoWise
Migrate from EcoTransIT

Transactions
Transaction documents
CSV upload

Dashboard

Share your climate impact

Analytics
Emissions explanations widget
Fullfilling audit requirements
Emissions reductions
Report pollutants
Data quality score

Analytics
Fullfilling audit requirements

Carbon credits via API

Carbon credits via dashboard

Lune Pay

Accounts

Emission calculations

Carbon credit orders

Webhooks

Logistics methodology

Spend management methodology

CSV reference

Authentication
Pagination
Rate limits
Error handling

General
Single leg
By fuel consumption

By transaction details
By document

Company
Electricity
Flight
Passenger transportation
Raw emission factor

Emission factors

Analytics
Sustainability pages

Quotes
Orders
Carbon certificates

Projects
Project bundles
Bundle selections
Bundle portfolios
Payments

Accounts
Client accounts

Webhook
Log inContact us

Analytics

Get cumulative analytics

HTTP GET to /v1/analytics/cumulative-per-bundle
Query parameters

The start date of the custom date range. Defaults to 30 days ago if not specified.

The to (inclusive) date of the custom date range. Defaults to the current date if not specified.

  • Sample request
    • Response

    An array of analytics by bundle objects.

    An array of analytics by bundle objects.

    The bundle's unique identifier

    The bundle's name

    A timeseries of quantities and values.

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Quantity of CO2 offsets linked to this activity (tonnes CO2)

  • Sample response
    • Errors
    This API operation can return the following errors:
    HTTP status codeError code
    400
    api_version_invalid
    400
    bundle_selection_ratios_invalid
    400
    bundle_selection_bundle_invalid
    400
    order_value_invalid
    400
    bundle_id_invalid
    400
    id_invalid
    400
    distance_invalid
    400
    test_account_name_update_disallowed
    400
    bundle_selection_ratios_invalid_format
    400
    address_not_found

    Get emission calculation metrics

    HTTP GET to /v1/analytics/emission-calculations
    Query parameters

    The start date of the custom date range. Defaults to 30 days ago if not specified.

    The to (inclusive) date of the custom date range. Defaults to the current date if not specified.

    The time interval over which metrics should be aggregated. Defaults to day if not specified.

    day
    month

    When true, metrics will include data from all accounts in the organisation. When false, metrics will only include data from the API Key's default account. Defaults to false.

  • Sample request
    • Response

    A timeseries representing counters.

  • Sample response
    • Errors
    This API operation can return the following errors:
    HTTP status codeError code
    400
    api_version_invalid
    400
    bundle_selection_ratios_invalid
    400
    bundle_selection_bundle_invalid
    400
    order_value_invalid
    400
    bundle_id_invalid
    400
    id_invalid
    400
    distance_invalid
    400
    test_account_name_update_disallowed
    400
    bundle_selection_ratios_invalid_format
    400
    address_not_found

    Get metrics

    HTTP GET to /v1/analytics/metrics
    Query parameters

    The start date of the custom date range. Defaults to 30 days ago if not specified.

    The to (inclusive) date of the custom date range. Defaults to the current date if not specified.

  • Sample request
    • Response

    The number of supported UN Sustainable Development Goals (SDGs).

    The number of supported carbon offset projects.

    The list of supported UN Sustainable Development Goals (SDGs).

    The array is sorted by the goal number (the un_sdg_number property), ascending.

    The number which identifies the specific UN SDG.

    The total number of projects supporting this UN SDG.

  • Sample response
    • Errors
    This API operation can return the following errors:
    HTTP status codeError code
    400
    api_version_invalid
    400
    bundle_selection_ratios_invalid
    400
    bundle_selection_bundle_invalid
    400
    order_value_invalid
    400
    bundle_id_invalid
    400
    id_invalid
    400
    distance_invalid
    400
    test_account_name_update_disallowed
    400
    bundle_selection_ratios_invalid_format
    400
    address_not_found

    Get aggregated analytics by property

    HTTP GET to /v1/analytics/aggregated-by-property
    Query parameters

    The start date of the custom date range. Defaults to 30 days ago if not specified.

    The to (inclusive) date of the custom date range. Defaults to the current date if not specified.

  • Sample request
    • Response

    An array of objects describing a bundle's aggregated orders.

    The bundle's unique identifier.

    The bundle's name.

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Quantity of CO2 offsets linked to this activity (tonnes CO2).

    Pattern: ^[0-9]+(\.[0-9]+)?$

    CO2 offsets' monetary value.

    An array of objects describing a location's aggregated orders.

    Project location (continent). If a project has yet to be assigned 'Not yet allocated' is returned instead.

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Quantity of CO2 offsets linked to this activity (tonnes CO2).

    Pattern: ^[0-9]+(\.[0-9]+)?$

    CO2 offsets' monetary value

    An array of objects describing a registry's aggregated orders.

    The project's Verification Standard Entity name or equivalent organization. If a project has no registry, 'Not certified' is returned. If a project has yet to be assigned, 'Not yet allocated' is returned.

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Quantity of CO2 offsets linked to this activity (tonnes CO2).

    Pattern: ^[0-9]+(\.[0-9]+)?$

    CO2 offsets' monetary value.

    An array of objects describing aggregated orders for each Oxford Offsetting Principle's type.

    Oxford Offsetting Principles' type.

    https://lune.co/blog/the-oxford-offsetting-principles-a-framework-to-maximise-the-impact-of-business-carbon-offsetting/.

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Quantity of CO2 offsets linked to this activity (tonnes CO2)

    Pattern: ^[0-9]+(\.[0-9]+)?$

    CO2 offsets' monetary value

    An array of objects describing aggregated orders by offset type.

    Offset type classification

    emissions_reduction
    carbon_removal

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Quantity of CO2 offsets linked to this activity (tonnes CO2)

    Pattern: ^[0-9]+(\.[0-9]+)?$

    CO2 offsets' monetary value

  • Sample response
    • Errors
    This API operation can return the following errors:
    HTTP status codeError code
    400
    api_version_invalid
    400
    bundle_selection_ratios_invalid
    400
    bundle_selection_bundle_invalid
    400
    order_value_invalid
    400
    bundle_id_invalid
    400
    id_invalid
    400
    distance_invalid
    400
    test_account_name_update_disallowed
    400
    bundle_selection_ratios_invalid_format
    400
    address_not_found

    Get business emissions analytics

    HTTP GET to /v1/analytics/businessGet business emissions analytics.Business analytics are calculated for transactions, transaction documents, passenger transportation and activity estimates that have their is_transaction, is_transaction_document, is_passenger_transportation properties set to true respectively.
    Query parameters

    The start date of the custom date range. Defaults to the date of the first estimate if not specified.

    The to (inclusive) date of the custom date range. Defaults to the current date if not specified.

  • Sample request
    • Response

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

    mg
    g
    kg
    t

    The number of estimates

    Emissions breakdown by business category

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

    mg
    g
    kg
    t

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

    mg
    g
    kg
    t

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

    mg
    g
    kg
    t

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

    mg
    g
    kg
    t

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

    mg
    g
    kg
    t

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

    mg
    g
    kg
    t

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

    mg
    g
    kg
    t

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

    mg
    g
    kg
    t

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

    mg
    g
    kg
    t

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

    mg
    g
    kg
    t

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

    mg
    g
    kg
    t

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

    mg
    g
    kg
    t

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

    mg
    g
    kg
    t

    Pattern: ^[0-9]+(\.[0-9]+)?$

    Unit, t for tonne, kg for kilogram, g for gram, mg for milligram

    mg
    g
    kg
    t
  • Sample response
    • Errors
    This API operation can return the following errors:
    HTTP status codeError code
    400
    api_version_invalid
    400
    bundle_selection_ratios_invalid
    400
    bundle_selection_bundle_invalid
    400
    order_value_invalid
    400
    bundle_id_invalid
    400
    id_invalid
    400
    distance_invalid
    400
    test_account_name_update_disallowed
    400
    bundle_selection_ratios_invalid_format
    400
    address_not_found