Hide navigation sidebar

Hide table of contents sidebar

Toggle site navigation sidebar

Toggle table of contents sidebar

User Guide

Getting Started
IPUMS Extracts
IPUMS Variables
Reading IPUMS Data
Command Line Interface

Reference

API
Toggle child pages in navigation
- REST API Interface
  Toggle child pages in navigation
  - ipumspy.api.IpumsApiClient
    Toggle child pages in navigation
  - ipumspy.api.BaseExtract
    Toggle child pages in navigation
  - ipumspy.api.OtherExtract
    Toggle child pages in navigation
    - ipumspy.api.OtherExtract.__init__
    - ipumspy.api.OtherExtract.build
  - ipumspy.api.UsaExtract
    Toggle child pages in navigation
    - ipumspy.api.UsaExtract.__init__
    - ipumspy.api.UsaExtract.build
  - ipumspy.api.CpsExtract
    Toggle child pages in navigation
    - ipumspy.api.CpsExtract.__init__
    - ipumspy.api.CpsExtract.build
  - ipumspy.api.IpumsiExtract
    Toggle child pages in navigation
    - ipumspy.api.IpumsiExtract.__init__
    - ipumspy.api.IpumsiExtract.build
  - ipumspy.api.Variable
    Toggle child pages in navigation
  - ipumspy.api.Sample
    Toggle child pages in navigation
    - ipumspy.api.Sample.__init__
    - ipumspy.api.Sample.update
  - ipumspy.api.extract_from_dict
  - ipumspy.api.extract_to_dict
  - ipumspy.api.extract.save_extract_as_json
  - ipumspy.api.extract.define_extract_from_json
  - ipumspy.api.exceptions.IpumsApiException
  - ipumspy.api.exceptions.TransientIpumsApiException
  - ipumspy.api.exceptions.IpumsExtractNotReady
  - ipumspy.api.exceptions.IpumsTimeoutException
  - ipumspy.api.exceptions.IpumsAPIAuthenticationError
  - ipumspy.api.exceptions.BadIpumsApiRequest
  - ipumspy.api.exceptions.IpumsExtractNotSubmitted
- DDI
  Toggle child pages in navigation
  - ipumspy.ddi.Codebook
    Toggle child pages in navigation
  - ipumspy.ddi.FileDescription
    Toggle child pages in navigation
    - ipumspy.ddi.FileDescription.__init__
    - ipumspy.ddi.FileDescription.read
  - ipumspy.ddi.VariableDescription
    Toggle child pages in navigation
    - ipumspy.ddi.VariableDescription.__init__
    - ipumspy.ddi.VariableDescription.read
- readers
  Toggle child pages in navigation
- noextract
  Toggle child pages in navigation
  - ipumspy.noextract.read_noextract_codebook
  - ipumspy.noextract.download_noextract_data
- utilities
  Toggle child pages in navigation
  - ipumspy.utilities.tabulate

Community

Contributing

Project History

Change Log

v: latest

Versions: latest; stable

Downloads

On Read the Docs: Project Home; Builds

Toggle table of contents sidebar

ipumspy.api.BaseExtract.extract_api_version#

BaseExtract.extract_api_version(kwargs_dict)[source]#

Return type:: str

ipumspy.api.BaseExtract.select_cases

ipumspy.api.BaseExtract.build

Copyright © 2021, Regents of the University of Minnesota

Made with Sphinx and @pradyunsg's Furo

On this page

ipumspy.api.BaseExtract.extract_api_version
- BaseExtract.extract_api_version()