Skip to main content

Utility to iterate over FEC filings through the FEC API

Project description

Documentation Status

Overview

fec-filing-iterator provides a simple interface for iterating through results from the Federal Election Commission’s API as a single, lazily evaluated stream. The FEC’s API provides access to a wealth of data on where candidates and committees get their funds, what they spend them on, and more. This library simply tries to make the API easier to work with in Python.

Getting Started

In order to use this library you will first need to get a data.gov API key, which you can request here. Once you get an API key you will be allowed to make 1,000 requests to the FEC API per hour. If you want more throughput you can request that your key be upgraded to be allowed to make 120 calls per minute by emailing APIinfo@fec.gov and asking nicely.

Next, you’ll have to install the library:

pip install fec-filing-iterator

Now you’re all set to start exploring campaign finance data! For example:

import json
from fec_filing_iterator import schedules

api_key = '<YOUR_DATA_DOT_GOV_API_KEY>'

params = {
    'two_year_transaction_period': 2020,
    'committee_id': 'C00696948',
}

for filing in schedules('a', api_key=api_key, params=params):
    print(json.dumps(filing, indent=4))

Factories and Iterators

This library only tries to provide an easy way to access and iterate through the paginated results returned by the FEC API. It does not currently attempt to provide a full and consistent interface for retrieving arbitrary subsets of information from the API. Lots of powerful searches and queries can be parameterized through the API, but we leave it up to you to read the FEC’s documentation and find the appropriate parameters yourself.

The main workhorse of the library is the FilingIterator class. Construct it with API credentials, an API endpoint to iterate over, and whatever parameters you want, and you can treat the full set of records as one big iterable.

The library also provides several handy factory functions that will construct the FilingIterator object and configure it for the appropriate endpoint.

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

fec_filing_iterator-1.0.0.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fec_filing_iterator-1.0.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file fec_filing_iterator-1.0.0.tar.gz.

File metadata

  • Download URL: fec_filing_iterator-1.0.0.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/28.8.0 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.6.1

File hashes

Hashes for fec_filing_iterator-1.0.0.tar.gz
Algorithm Hash digest
SHA256 39bf2e5d1d0bf042d6f3201eb5533d16ab55a63acd64f71a0f034e9205721a1d
MD5 ede2eb95e634312c6d413be2f0fcdcdf
BLAKE2b-256 86da7d35989531e33ca6aac0abeaa75177f78a8ae124f1559c1bb449f47bf5f7

See more details on using hashes here.

File details

Details for the file fec_filing_iterator-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: fec_filing_iterator-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/28.8.0 requests-toolbelt/0.9.1 tqdm/4.40.1 CPython/3.6.1

File hashes

Hashes for fec_filing_iterator-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ab3989d4022f0d7f3a9813a7d9e898e378087e54ed7efe763ef7cd21a07946aa
MD5 580d4687c9f7bdf45da2c51e8cb2e14f
BLAKE2b-256 5d5a559e8d791b027c6be63a7b2bb836665888974f010cc2d13eb3dca2e0ccb0

See more details on using hashes here.

Supported by

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