Skip to main content

API Wrapper for The Observatory for Economic Complexity

Project description

Python Wrapper for The Observatory for Economic Complexity API

Language: Python 3
Data Source: Observatory for Economic Complexity (OEC)

Status

As of June 2021, the OEC has migrated to a new website at oec.world, and this new site no longer hosts a free API. There is a legacy version of the site hosted at legacy.oec.world, and this library has been updated to refer to that legacy version.

Installation

pip install oec

Usage

Get data from OEC

import oec

# Set parameters in accordance with API documentation
params = {'classification': 'hs92',
          'trade_flow': 'export',
          'year': 2015,
          'origin': 'egy',
          'destination': 'all',
          'product': 'show'}

list_of_countries = oec.get_countries()
list_of_products = oec.get_products(params['classification'])
list_of_exports = oec.get_trade(**params)

These functions each return lists of dictionaries. Each of these dictionaries represents a "row" of data (e.g. one country or product). The fields of these dictionaries represent "columns" of data. This is easier to visualize if you output your data to a CSV file.

Export to CSV

oec.data_to_csv(list_of_dictionaries, 'results.csv')

These CSV files can then be opened up in the spreadsheet editor of your choice for further analysis.

Generate links to visualizations

>>> oec.url_visual(**params)
'https://legacy.oec.world/en/visualize/tree_map/hs92/export/egy/all/show/2015/'
>>> oec.embed_visual(**params)
'<iframe src="https://legacy.oec.world/en/visualize/embed/tree_map/hs92/export/egy/all/show/2015/" width=930 height=400></iframe>'
>>> oec.url_visual(**params, language='fr')
'https://legacy.oec.world/fr/visualize/tree_map/hs92/export/egy/all/show/2015/'

Documentation

Function-level documentation and language list: see help.txt or run python -m pydoc oec
OEC API documentation
Data attributes and field names

Acknowledgements

Credits to Alex Simoes for the development of The Observatory for Economic Complexity. This module was developed by Yahia Ali, who is not affiliated in any way with the OEC team.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oec-0.3.0.tar.gz (4.3 kB view hashes)

Uploaded Source

Built Distribution

oec-0.3.0-py3-none-any.whl (5.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page