imfpy.searches
Module Contents
Functions
|
Function to identify country codes and names from a keyword seach. |
Function returns a dataframe of all IMF countries and codes for which data can be accessed through the JSON API. |
|
Function returns a dataframe of all IMF databases from which data can be accessed through the JSON API. |
|
|
Function to identify database codes and names from a keyword seach. |
|
Returns the high-level information on a particular user-specified database. |
|
This function returns the dimensions of a particular user-specified database. |
|
Function returns a dataframe of indicator dimensions and series IDs |
Attributes
Cache for countries data |
|
Cache for databases data |
- imfpy.searches.country_cache
Cache for countries data
- imfpy.searches.database_cache
Cache for databases data
- imfpy.searches.country_search(keyword, regex=False)[source]
Function to identify country codes and names from a keyword seach. It also returns codes from aggregated spatial units. The function returns a pandas dataframe of country codes and countries matching the search, which can be done by normal string methods (the default) or a regular expression The search operates on cached data or calls country_codes if the cache is empty.
- Parameters
keyword (str or regular expression) – The keyword or regular expression to search. Not case-sensitive.
regex (bool (optional), default=False) – Whether the keyword should be searched as a regular expression. Defaults to False, in which case normal string matching is used.
- Returns
match – A DataFrame of matched results, including country code and country.
- Return type
pandas.core.frame.DataFrame
Examples
>>> searches.country_search("germany") Returns keyword matches for simple string search "germany"
>>> searches.country_search("^B.*a$", regex=True) Returns matches for countries starting with B and ending in a
- imfpy.searches.country_codes()[source]
Function returns a dataframe of all IMF countries and codes for which data can be accessed through the JSON API. The resulting dataframe is cached to the local environment using a simple technique.
- Parameters
None –
- Returns
database_cache – A DataFrame of all country names and codes, cached to local environment.
- Return type
pandas.core.frame.DataFrame
Examples
>>> searches.country_codes() Returns country codes and caches to local environment.
- imfpy.searches.database_codes()[source]
Function returns a dataframe of all IMF databases from which data can be accessed through the JSON API. The resulting dataframe is cached to the local environment using a simple technique.
- Parameters
None –
- Returns
database_cache – A DataFrame of all Database names and codes, cached to local environment.
- Return type
pandas.core.frame.DataFrame
Examples
>>> searches.database_codes() Returns database codes and caches to local environment.
- imfpy.searches.database_search(keyword, regex=False)[source]
Function to identify database codes and names from a keyword seach. The function returns a pandas dataframe of database codes and databases matching the search, which can be done by normal string methods (the default) or a regular expression The search operates on cached data or calls database_codes if the cache is empty.
- Parameters
keyword (str or regular expression) – The keyword or regular expression to search. Not case-sensitive.
regex (bool (optional), default=False) – Whether the keyword should be searched as a regular expression. Defaults to False, in which case normal string matching is used.
- Returns
match – A DataFrame of matched results, including database code and database.
- Return type
pandas.core.frame.DataFrame
Examples
>>> searches.database_search("development") Returns keyword matches for simple string search "development"
>>> searches.database_search("^Financial.*", regex=True) Returns matches for databases that start with "Financial"
- imfpy.searches.database_info(database_id)[source]
Returns the high-level information on a particular user-specified database.
- Parameters
database_id (str) – The database ID of the database of interest. Checks against database cache to validate input.
- Returns
info – A DataFrame of information (update time, name, definition, methodology, etc.) about the specified database.
- Return type
pandas.core.frame.DataFrame
Examples
>>> searches.database_info('FSI') Returns information about the database 'FSI' (Financial Soundness Indicators)
- imfpy.searches.database_dimensions(database_id)[source]
This function returns the dimensions of a particular user-specified database. Database dimensions are effectively indicator collections indexed by an indicator_id.
- Parameters
database_id (str) – The database ID of the database of interest. Checks against database cache to validate input.
- Returns
dimensions – A DataFrame of dimensions (typically frequencies, spatial units and indicators) that can be accessed through the specified database
- Return type
pandas.core.frame.DataFrame
Examples
>>> searches.database_dimensions('FSI') Returns dimensions of the database 'FSI' (Financial Soundness Indicators)
- imfpy.searches.indicator_dimensions(indicator_id)[source]
Function returns a dataframe of indicator dimensions and series IDs (i.e. the most granular unit of data apart from individual values) for a given user-specified indicator ID. Indicator dimensions are single time series.
- Parameters
indicator_id (str) – The indicator ID of the indicator of interest.
- Returns
indicator_dimensions – A DataFrame of indicator dimensions or series that can be accessed via a particular indicator_id
- Return type
pandas.core.frame.DataFrame
Examples
>>> searches.indicator_dimensions('CL_INDICATOR_FSI') Returns indicators dimensions and series for the indicator ID 'CL_INDICATOR_FSI'