API Documentation

This page documents the current views implementing the REST endpoints of the openNPL server. The overall structure is as follows:

  • api_root (overall API root)

  • npl_api_root (npl data API root)

    • npl_DATA_MODEL_api collections of DATA_MODEL

    • npl_DATA_MODEL_detail instances of DATA_MODEL

Todo

Some models only implement collective (list) views, detailed views to be implemented in due course

openNPL.npl_views.api_root(request, *args, **kwargs)

Returns a list of all active API endpoints for EBA NPL Template Data

openNPL.npl_views.npl_api_root(request, *args, **kwargs)

Returns a list of all active API endpoints in the OpenNPL installation, grouped by functionality:

  • NPL Data Endpoints implements a REST CRUD interface to EBA Templated NPL Data

  • SFLP Data Endpoints implements a REST CRUD interface to US Agency Single Family Loan Performance Data

openNPL.npl_views.npl_counterparty_api(request, *args, **kwargs)

List Counterparties (EBA Template)

openNPL.npl_views.npl_counterparty_detail(request, *args, **kwargs)
openNPL.npl_views.npl_counterparty_group_api(request, *args, **kwargs)

List Counterparty Groups (EBA Template)

openNPL.npl_views.npl_counterparty_group_detail(request, *args, **kwargs)

List the data a specific EBA Counterparty Group

openNPL.npl_views.npl_enforcement_api(request, *args, **kwargs)

List Enforcements (EBA Template)

openNPL.npl_views.npl_enforcement_detail(request, *args, **kwargs)

List the data a specific EBA Enforcement entry

openNPL.npl_views.npl_external_collection_api(request, *args, **kwargs)

List External Collections (EBA Template)

openNPL.npl_views.npl_external_collection_detail(request, *args, **kwargs)
openNPL.npl_views.npl_forbearance_api(request, *args, **kwargs)

List Forbearance (EBA Template)

openNPL.npl_views.npl_forbearance_detail(request, *args, **kwargs)

List the data a specific EBA Forbearance entry

openNPL.npl_views.npl_loan_api(request, *args, **kwargs)

List Loans (EBA Template)

openNPL.npl_views.npl_loan_detail(request, *args, **kwargs)

List the data a specific EBA Loan

openNPL.npl_views.npl_nonproperty_collateral_api(request, *args, **kwargs)

List NonProperty Collateral (EBA Template)

openNPL.npl_views.npl_nonproperty_collateral_detail(request, *args, **kwargs)

List the data a specific EBA Non Property Collateral

openNPL.npl_views.npl_property_collateral_api(request, *args, **kwargs)

List Property Collateral (EBA Template)

openNPL.npl_views.npl_property_collateral_detail(request, *args, **kwargs)

List the data a specific EBA Property Collateral

openNPL.sflp_views.api_root(request, *args, **kwargs)

Returns a list of all active API endpoints in the OpenNPL installation, grouped by functionality:

  • NPL Data Endpoints implements a REST CRUD interface to EBA Templated NPL Data

openNPL.sflp_views.sflp_api_root(request, *args, **kwargs)

Returns a list of all active API endpoints for EBA NPL Template Data

openNPL.sflp_views.sflp_counterparty_api(request, *args, **kwargs)

List Counterparties (EBA Template)

openNPL.sflp_views.sflp_counterparty_detail(request, *args, **kwargs)
openNPL.sflp_views.sflp_enforcement_api(request, *args, **kwargs)

List Enforcements (EBA Template)

openNPL.sflp_views.sflp_enforcement_detail(request, *args, **kwargs)

List the data a specific EBA Enforcement entry

openNPL.sflp_views.sflp_forbearance_api(request, *args, **kwargs)

List Forbearance (EBA Template)

openNPL.sflp_views.sflp_forbearance_detail(request, *args, **kwargs)

List the data a specific EBA Forbearance entry

openNPL.sflp_views.sflp_loan_api(request, *args, **kwargs)

List Loans (EBA Template)

openNPL.sflp_views.sflp_loan_detail(request, *args, **kwargs)

List the data a specific EBA Loan

openNPL.sflp_views.sflp_property_collateral_api(request, *args, **kwargs)

List Property Collateral (EBA Template)

openNPL.sflp_views.sflp_property_collateral_detail(request, *args, **kwargs)

List the data a specific EBA Property Collateral