SWswissfintechinnovations
Mortgage Products and Conditions

Get a list of all mortgage products

Changed on

Get a complete overview of all available mortgage products sorted by productId.

get/mortgages/products

Request

  • Base URL
    https://mortgage.common-api.ch
  • URL
    https://mortgage.common-api.ch/mortgages/products
  • Auth
    • API key in header X-API-Key
    • or OAuth 2
      Authorization code: https://example.com/oauth/authorize
      Token URL: https://example.com/oauth/token scopes: read, write

Query parameters

interest_rate_type'variable' | 'libor' | 'saron' | 'fixed'
Example:saron

The type of the interest rates (for filtering).

durationinteger
Example:10

The type of duration (for filtering).

cursorstring
Example:cursorIDxyz

Optional parameter for pagination. An opaque string value used for pagination.

limitinteger
Example:25

Optional parameter for pagination. Maximum number of entries to be returned.

Headers

X-CorAPI-Client-IDstring required

ID of the client forwarded to the provider.

X-Correlation-IDstring required

Unique ID (defined by the caller) which will be reflected back in the response.

User-Agentstring required

Name and version of the of the Client software.

Response

Paginated list of all mortgage products with all related information sorted by productId.

Example response

{
  "productList": [
    {
      "interestRateType": "libor",
      "names": [
        {
          "description": "Fixed rate mortgage",
          "language": "fr"
        }
      ],
      "productId": "4bf92636-14a0-4511-98e2-acfde576e644",
      "productVariations": [
        {
          "duration": 5,
          "rate": 0.5,
          "saronperiod": "3m"
        }
      ]
    }
  ]
}

Changes

  • 735bf0a87227Revision changes
    • info

      api operation id listProducts was added

  • 990b493a4a31Revision changes
    • warning

      deleted the query request parameter offset

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter cursor

    • info

      the response property became required for the status