API reference · Communities & institutions

Rental markets

GET/rental/market/{code}The market profile in force

GET The market profile in force

GET /rental/market/{code}

The same for every caller: the caps, the fees an occupant may be asked to pay, and who holds a deposit here. This is how an occupant finds out before signing anything that a letting fee would be unlawful or that their deposit will be held by a statutory scheme.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`code`

Example

Response: GenericResponseMarketProfileResponse

curl -X GET "https://api.bridgemoni.com/rental/market/value" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "marketCode": "string",
    "version": 0,
    "status": "DRAFT",
    "countryCode": "string",
    "subdivisionCode": "string",
    "displayName": {
      "name": "string"
    },
    "defaultCurrencyCode": "string",
    "languages": [
      "string"
    ],
    "effectiveFrom": "2026-09-25",
    "rentShape": "PERIODIC_IN_ARREARS",
    "advanceMaximumPeriods": 0,
    "advanceExemptAreas": [
      "string"
    ],
    "noticePeriods": {},
    "rentIncreaseRegime": "NONE",
    "feeRegime": "OCCUPANT_FEES_PERMITTED",
    "permittedOccupantCharges": [
      "RENT"
    ],
    "depositCapBasis": "NONE",
    "depositCapValue": 0,
    "holdingDepositCapBasis": "NONE",
    "holdingDepositCapValue": 0,
    "depositCustodyRegime": "PLATFORM_ESCROW",
    "depositCustodyProvider": "string",
    "depositLodgementDeadlineDays": 0,
    "depositInterestBeneficiary": "NONE",
    "depositHeldBy": "PLATFORM",
    "clientMoneyRegime": "PASS_THROUGH",
    "clientMoneyAccountType": "main",
    "settlementDeadlineHours": 0,
    "screeningRegime": "SUBJECT_HELD",
    "identityRegime": "NATIONAL_ID_VERIFIABLE",
    "kycTierModel": "string",
    "rentScaleMinimumTier": 0,
    "statutoryDeductionProvider": "string",
    "nonResidentWithholdingPercent": 0,
    "registrationRegime": "NONE",
    "registrationProvider": "string",
    "dataProtectionRegime": "NDPA",
    "retentionCeilingMonths": 0,
    "erasureModel": "PSEUDONYMISE_PARTY_RETAIN_POSTING",
    "enabledRails": [
      "WALLET"
    ],
    "railRevocationWindows": {},
    "operatingEntity": {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "marketCode": "string",
      "legalName": {
        "name": "string"
      },
      "status": "ACTIVE",
      "accounts": [
        {
          "accountType": "main",
          "currencyCode": "string",
          "accountReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "accountNumber": "string"
        }
      ]
    },
    "enabledAt": "2026-09-25T10:00:00Z",
    "creationDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Market profile retrieved successfully"
}

Responses

Status	When
`200`	Market profile retrieved successfully
`409`	The market is not enabled

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors