Consumerfinance

Consumerfinance is the Consumer Financial Protection Bureau data API for accessing public consumer finance information.

• Base URL: https://api.consumerfinance.gov:443
• Auth: bearer (pass your key via the apiKey input)

Operations

• getdatasets — GET /data — Get a list of all datasets.
• getdatasethmda — GET /data/hmda — Get metadata for this dataset.
• getconcepthmda — GET /data/hmda/concept/{concept} — Get information about a particular concept in this dataset.
• queryslicehmda — GET /data/hmda/slice/{slice} — Query a slice in this dataset.
• getslicemetadatahmda — GET /data/hmda/slice/{slice}/metadata — Get the metadata for a slice in this dataset.
• getdataset — GET /data/{dataset} — Get metadata about a dataset.

Inputs

• apiKey — your consumerfinance API key
• operation — one of the operations above
• path parameters when an operation's path contains {...}
• query — optional JSON object of query params
• body — JSON object for create/update ops

Example

operation: getdatasets
apiKey: <your key>

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

• error
• operation
• result
• status

Input Properties

Every property this tool accepts, from its own tool.iml.