cenpy.remote.APIConnection¶
-
class
cenpy.remote.
APIConnection
(api_name=None, apikey='')[source]¶ The fundamental building block for US Census Bureau data API Endpoints
Methods
explain
(self, \*args[, verbose])Explain a column or list of columns.
query
(self[, cols, geo_unit, geo_filter, apikey])Conduct a query over the USCB api connection
set_mapservice
(self, key)Assign a mapservice to the connection instance
varslike
(self[, pattern, by, engine, within])Grabs columns that match a particular search pattern.
-
__init__
(self, api_name=None, apikey='')[source]¶ Constructor for a Connection object
- Parameters
- api_namestr
shortcode identifying which api to connect to
- api_keystr
US Census bureau API key
Methods
__init__
(self[, api_name, apikey])Constructor for a Connection object
explain
(self, \*args[, verbose])Explain a column or list of columns.
query
(self[, cols, geo_unit, geo_filter, apikey])Conduct a query over the USCB api connection
set_mapservice
(self, key)Assign a mapservice to the connection instance
varslike
(self[, pattern, by, engine, within])Grabs columns that match a particular search pattern.
-