{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:ducky/calculate-financial-footprint-for-transactions":{"post":{"operationId":"open_data_ducky_calculate_financial_footprint_for_transactions","summary":"Get kgCO2e per monetary transaction","description":"POST /calculate/finance","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"dataSource":{"type":"string","enum":["norway"],"default":"norway","description":"Data Source to use for calculation"},"categoryMapping":{"type":"string","default":"ducky","description":"Format output based on a custom mapping"},"dataFromDate":{"type":"string","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/calculate-food-and-drink-metrics":{"post":{"operationId":"open_data_ducky_calculate_food_and_drink_metrics","summary":"Get kgCO2e, weight, waste, and money spent per food category.","description":"POST /calculate/food-and-drink","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"dataSource":{"type":"string","enum":["norway"],"default":"norway","description":"Data Source to use for calculation"},"dataFromDate":{"type":"string","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/calculate-annual-footprint-by-categories":{"post":{"operationId":"open_data_ducky_calculate_annual_footprint_by_categories","summary":"Calculate annual footprint by categories","description":"POST /calculator","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"dataSource":{"type":"string","enum":["norway","japan","united_kingdom"],"default":"norway","description":"Data Source to use for calculation"},"categories":{"type":"array","default":"[\"public\",\"consumption\",\"transport\",\"food\",\"energy\"]","description":"Categories to include in response"},"subCategories":{"type":"boolean","default":false,"description":"Include subcategories"},"scope":{"type":"string","enum":["household","individual"],"default":"household","description":"Is the footprint for an individual or a household"},"precision":{"type":"boolean","default":false,"description":"Prevent rounding of percentages"},"dataFromDate":{"type":"string","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/change-improve-behaviour-tips":{"post":{"operationId":"open_data_ducky_change_improve_behaviour_tips","summary":"Get tips for improving behaviour.","description":"POST /change","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"dataSource":{"type":"string","enum":["norway","japan","united_kingdom"],"default":"norway","description":"Region of the requested data set"},"dataFromDate":{"type":"string","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"},"language":{"type":"string","enum":["no","ja","en"],"default":"no","description":"Language of the text returned"},"orderBy":{"type":"string","enum":["co2","points","moneySaved","financialCost","timeRequirement","socialDifficulty","random"],"default":"co2","description":"Order the results using the specified attribute. The attributes of type \"indicator\" (co2, points, moneySaved) are sorted by descending…"},"returnLegacyTipId":{"type":"boolean","default":false,"description":"Choose whether the legacy tipID should be outputted."},"ignoreZeroOrNegativeTips":{"type":"boolean","default":true,"description":"Choose whether to ignore tips that would produce a zero or negative impact in terms of CO2 footprint. Such cases will happen if a user…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/compare-average-footprint-by-filtering-criteria":{"post":{"operationId":"open_data_ducky_compare_average_footprint_by_filtering_criteria","summary":"Fetch an average food-and-drink footprint based on filtering criteria.","description":"POST /compare/food-and-drink","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/compare-average-category-footprint":{"post":{"operationId":"open_data_ducky_compare_average_category_footprint","summary":"Fetch an average category-based footprint based on filtering criteria.","description":"POST /compare/general","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/compare-transport-footprint":{"post":{"operationId":"open_data_ducky_compare_transport_footprint","summary":"Fetch transport footprint for a given area.","description":"POST /compare/transport","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["areaId"],"properties":{"dataFromDate":{"type":"string","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"},"areaId":{"type":"string","description":"Area code of the area for which transport footprint is requested. [See detailed area ID…"},"timeRange":{"type":"string","enum":["monthly","yearly"],"default":"monthly","description":"Choose which time range you wish to receive data for. Currently the most granular data available is per month, which means that if a…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/convert-kg-co2e-per-kwh-used":{"post":{"operationId":"open_data_ducky_convert_kg_co2e_per_kwh_used","summary":"Get kgCO2e per kWh used.","description":"POST /convert/energy","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"dataSource":{"type":"string","enum":["norway"],"default":"norway","description":"Data Source to use for calculation"},"dataFromDate":{"type":"string","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/convert-financial-footprint-by-category":{"post":{"operationId":"open_data_ducky_convert_financial_footprint_by_category","summary":"Get footprint in kilograms of CO2-equivalents for financial transactions by category.","description":"POST /convert/finance","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"dataSource":{"type":"string","enum":["norway","denmark","sweden","finland"],"default":"norway","description":"Data Source to use for calculation"},"dataFromDate":{"type":"string","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/convert-food-and-drink-footprint":{"post":{"operationId":"open_data_ducky_convert_food_and_drink_footprint","summary":"Get kgCO2e per calory or weight of Food and Drink.","description":"POST /convert/food-and-drink","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"dataSource":{"type":"string","enum":["norway"],"default":"norway","description":"Data Source to use for calculation"},"dataFromDate":{"type":"string","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/convert-item-footprint-and-savings":{"post":{"operationId":"open_data_ducky_convert_item_footprint_and_savings","summary":"Get footprint of an item and optionally the avoided emissions obtained by choosing to rent, repair or buy an…","description":"POST /convert/goods-and-services","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"dataSource":{"type":"string","enum":["norway"],"default":"norway","description":"Data Source to use for calculation"},"dataFromDate":{"type":"string","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/convert-goods-and-services-list-items":{"get":{"operationId":"open_data_ducky_convert_goods_and_services_list_items","summary":"Get a list of all valid items for the convert/goods-and-services endpoint.","description":"GET /convert/goods-and-services/list-items","tags":["open-data"],"parameters":[{"name":"dataSource","in":"query","required":false,"description":"Data Source to use for calculation","schema":{"type":"string","enum":["norway"],"default":"norway","description":"Data Source to use for calculation"}},{"name":"dataFromDate","in":"query","required":false,"description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…","schema":{"type":"string","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:ducky/convert-transport-emissions":{"post":{"operationId":"open_data_ducky_convert_transport_emissions","summary":"Get kgCO2e per distance travelled.","description":"POST /convert/transport","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"dataSource":{"type":"string","enum":["norway"],"default":"norway","description":"Data Source to use for calculation"},"dataFromDate":{"type":"string","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/ping-status-check":{"get":{"operationId":"open_data_ducky_ping_status_check","summary":"Check if the API is running","description":"GET /ping","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:ducky/ping-check-token-validity":{"get":{"operationId":"open_data_ducky_ping_check_token_validity","summary":"Check if the API is running and if your authentication token is valid","description":"GET /ping/protected","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:ducky/reporting-compute-scope1-emissions":{"post":{"operationId":"open_data_ducky_reporting_compute_scope1_emissions","summary":"Compute Scope 1 GHG emissions.","description":"POST /report/scope-1","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"dataSource":{"type":"string","enum":["norway"],"default":"norway","description":"Data Source to use for calculation"},"dataFromDate":{"type":"string","default":"today","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/reporting-compute-scope2-emissions":{"post":{"operationId":"open_data_ducky_reporting_compute_scope2_emissions","summary":"Compute Scope 2 GHG emissions.","description":"POST /report/scope-2","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"dataSource":{"type":"string","enum":["norway"],"default":"norway","description":"Data Source to use for calculation"},"dataFromDate":{"type":"string","default":"today","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/track-transport-indicators":{"post":{"operationId":"open_data_ducky_track_transport_indicators","summary":"Get indicators for a certain administrative area.","description":"POST /track/transport","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"dataFromDate":{"type":"string","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"},"timeRange":{"type":"string","enum":["monthly","yearly"],"default":"monthly","description":"Choose which time range you wish to receive data for. Currently the most granular data available is per month, which means that if a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/translate-co2e-to-car-distance":{"post":{"operationId":"open_data_ducky_translate_co2e_to_car_distance","summary":"Translate kilograms CO2 equivalent to distance travelled by car","description":"POST /translate/car","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"dataSource":{"type":"string","enum":["norway","japan"],"default":"norway","description":"Region of the requested data set"},"dataFromDate":{"type":"string","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/translate-co2e-to-energy-usage":{"post":{"operationId":"open_data_ducky_translate_co2e_to_energy_usage","summary":"Translate kilograms CO2 equivalent to the usage of an electrical appliance.","description":"POST /translate/energy","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"dataSource":{"type":"string","enum":["norway","japan"],"default":"norway","description":"Region of the requested data set"},"dataFromDate":{"type":"string","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/translate-co2e-to-plane-distance":{"post":{"operationId":"open_data_ducky_translate_co2e_to_plane_distance","summary":"Translate kilograms CO2 equivalent to distance flown by an airplane.","description":"POST /translate/plane","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"dataSource":{"type":"string","enum":["norway"],"default":"norway","description":"Region of the requested data set"},"dataFromDate":{"type":"string","description":"You can choose to use data from any date for which we have data in our database. If you do not submit a date, the current (and thereby the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:ducky/translate-co2e-to-tree-area":{"post":{"operationId":"open_data_ducky_translate_co2e_to_tree_area","summary":"Translate kilograms CO2 equivalent to how quickly it can be absorbed by a number of trees.","description":"POST /translate/tree","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"dataSource":{"type":"string","enum":["norway","japan"],"default":"norway","description":"Region of the requested data set"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}