Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/areed1192/python-bureau-economic-analysis-api-client

A Python API client used to pull and retrieve data from the US Bureau of Economic Analysis
https://github.com/areed1192/python-bureau-economic-analysis-api-client

api-client bureau-of-economic-analysis finance python

Last synced: 14 days ago
JSON representation

A Python API client used to pull and retrieve data from the US Bureau of Economic Analysis

Host: GitHub
URL: https://github.com/areed1192/python-bureau-economic-analysis-api-client
Owner: areed1192
License: mit
Created: 2020-07-10T17:32:15.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2021-12-23T17:03:44.000Z (almost 3 years ago)
Last Synced: 2024-10-29T01:12:46.669Z (15 days ago)
Topics: api-client, bureau-of-economic-analysis, finance, python
Language: Python
Homepage:
Size: 1.67 MB
Stars: 21
Watchers: 2
Forks: 15
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# Python Bureau Of Economic Analysis API Client

## Table of Contents

- [Overview](#overview)
- [Setup](#setup)
- [Usage](#usage)
- [Support These Projects](#support-these-projects)

## Overview

An Python API client used to pull and retrieve data from the US Bureau of Economic Analysis.

## Grab an API Key

To grab an API key, you'll need to setup an account with the Bureau Of Economic Analysis. Go to the
[API Homepage](https://apps.bea.gov/API/signup/index.cfm) and fill out the register form on the left
hand side. Once filled out an API key will be sent to your email.

## Setup

Right now, the library is not hosted on **PyPi** so you will need to do a local install on your system if you plan
to use it in other scrips you use.

First, clone this repo to your local system. After you clone the repo, make sure to run the `setup.py` file, so you
can install any dependencies you may need. To run the `setup.py` file, run the following command in your terminal.

```console
pip install python-bea
```

This will install all the dependencies listed in the `setup.py` file. Once done you can use the library
wherever you want.

## Usage

Here is a simple example of using the `pybea` library to grab a list of the different datasets availabel.

```python
from pprint import pprint
from pybea.client import BureauEconomicAnalysisClient

# Initalize the new Client.
bea_client = BureauEconomicAnalysisClient(api_key='YOUR_API_KEY_HERE')

# Grab the Dataset List.
dataset_list = bea_client.get_dataset_list()
pprint(dataset_list)
```

You will note the output of the above code would look like the following:

```json
{
"BEAAPI": {
"Request": {
"RequestParam": [
{
"ParameterName": "METHOD",
"ParameterValue": "GETPARAMETERLIST"
},
{
"ParameterName": "RESULTFORMAT",
"ParameterValue": "JSON"
}
]
},
"Results": {
"Parameter": [
{
"ParameterName": "GeoFips",
"ParameterDataType": "string",
"ParameterDescription": "Comma-delimited list of 5-character geographic codes; COUNTY for all counties, STATE for all states, MSA for all MSAs, MIC for all Micropolitan Areas, PORT for all state metro/nonmetro portions, DIV for all Metropolitan Divisions, CSA for all Combined Statistical Areas, state post office abbreviation for all counties in one state (e.g. NY)",
"ParameterIsRequiredFlag": "1",
"MultipleAcceptedFlag": "1"
},
{
"ParameterName": "Year",
"ParameterDataType": "string",
"ParameterDescription": "Comma-delimted list of years; LAST5 for latest 5 years; LAST10 for latest 10 years; ALL for all years",
"ParameterIsRequiredFlag": "0",
"ParameterDefaultValue": "LAST5",
"MultipleAcceptedFlag": "1"
}
]
}
}
}
```

## Support these Projects

**Patreon:**
Help support this project and future projects by donating to my [Patreon Page](https://www.patreon.com/sigmacoding).
I"m always looking to add more content for individuals like yourself, unfortuantely some of the APIs I would
require me to pay monthly fees.

**YouTube:**
If you"d like to watch more of my content, feel free to visit my YouTube
channel [Sigma Coding](https://www.youtube.com/c/SigmaCoding).