HOUSINGFAX · JSON-LD Context
Housingfax Com Context
JSON-LD context defining the semantic vocabulary for Housingfax Com from HOUSINGFAX.
10 Classes
61 Properties
4 Namespaces
Namespaces
schema:
https://schema.org/
xsd:
http://www.w3.org/2001/XMLSchema#
dcterms:
http://purl.org/dc/terms/
housingfax:
https://housingfax.com/schema#
Classes
GetProductsOutput
ListChecksOutput
CheckCoverageOutput
ResolveBuildingOutput
CreateFreeReportOutput
CreateFreeReportInput
GetJobStatusOutput
PurchaseReportOutput
PurchaseReportInput
AgentApiError
Properties
| Property | Type | Container |
|---|---|---|
| contract | string | |
| language | string | |
| productMode | string | |
| currency | string | |
| vatIncluded | boolean | |
| priceNote | string | |
| products | list | |
| upgrade | ||
| freeReportLimits | ||
| capacity | ||
| consent | ||
| checksCount | integer | |
| pricingUrl | string | |
| orderUrl | string | |
| exampleReportUrl | string | |
| disclaimer | string | |
| count | integer | |
| checks | list | |
| semaphore | ||
| methodologyUrl | string | |
| provinces | list | |
| municipalities | ||
| municipalityLookup | string | |
| coverageNote | string | |
| status | string | |
| evaluationScope | ||
| building | ||
| candidates | list | |
| availableNumbers | list | |
| resolutionToken | ||
| resolutionExpiresInSeconds | ||
| ieeAvailability | ||
| availableTiers | list | |
| notice | string | |
| jobId | string | |
| statusToken | string | |
| previewUrl | string | |
| pollAfterSeconds | integer | |
| emailNotice | boolean | |
| consentStatementSha256 | string | |
| string | ||
| stage | ||
| queuePosition | integer | |
| estimatedSeconds | integer | |
| withLimitations | boolean | |
| errorCode | string | |
| payment | ||
| orderId | string | |
| tier | string | |
| name | string | |
| priceCents | integer | |
| price | string | |
| checkoutUrl | string | |
| checkoutExpiresAt | dateTime | |
| reportUrl | string | |
| termsVersion | string | |
| agentContractingTermsUrl | string | |
| freeReport | ||
| acceptTerms | boolean | |
| waiveWithdrawalRight | boolean | |
| error |
JSON-LD Document
{
"@context": {
"@vocab": "https://housingfax.com/schema#",
"schema": "https://schema.org/",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"dcterms": "http://purl.org/dc/terms/",
"housingfax": "https://housingfax.com/schema#",
"GetProductsOutput": "housingfax:GetProductsOutput",
"contract": {
"@id": "housingfax:contract",
"@type": "xsd:string"
},
"language": {
"@id": "housingfax:language",
"@type": "xsd:string"
},
"productMode": {
"@id": "housingfax:productMode",
"@type": "xsd:string"
},
"currency": {
"@id": "housingfax:currency",
"@type": "xsd:string"
},
"vatIncluded": {
"@id": "housingfax:vatIncluded",
"@type": "xsd:boolean"
},
"priceNote": {
"@id": "housingfax:priceNote",
"@type": "xsd:string"
},
"products": {
"@id": "housingfax:products",
"@container": "@list"
},
"upgrade": {
"@id": "housingfax:upgrade"
},
"freeReportLimits": {
"@id": "housingfax:freeReportLimits"
},
"capacity": {
"@id": "housingfax:capacity"
},
"consent": {
"@id": "housingfax:consent"
},
"checksCount": {
"@id": "housingfax:checksCount",
"@type": "xsd:integer"
},
"pricingUrl": {
"@id": "housingfax:pricingUrl",
"@type": "xsd:string"
},
"orderUrl": {
"@id": "housingfax:orderUrl",
"@type": "xsd:string"
},
"exampleReportUrl": {
"@id": "housingfax:exampleReportUrl",
"@type": "xsd:string"
},
"disclaimer": {
"@id": "housingfax:disclaimer",
"@type": "xsd:string"
},
"ListChecksOutput": "housingfax:ListChecksOutput",
"count": {
"@id": "housingfax:count",
"@type": "xsd:integer"
},
"checks": {
"@id": "housingfax:checks",
"@container": "@list"
},
"semaphore": {
"@id": "housingfax:semaphore"
},
"methodologyUrl": {
"@id": "housingfax:methodologyUrl",
"@type": "xsd:string"
},
"CheckCoverageOutput": "housingfax:CheckCoverageOutput",
"provinces": {
"@id": "housingfax:provinces",
"@container": "@list"
},
"municipalities": {
"@id": "housingfax:municipalities"
},
"municipalityLookup": {
"@id": "housingfax:municipalityLookup",
"@type": "xsd:string"
},
"coverageNote": {
"@id": "housingfax:coverageNote",
"@type": "xsd:string"
},
"ResolveBuildingOutput": "housingfax:ResolveBuildingOutput",
"status": {
"@id": "housingfax:status",
"@type": "xsd:string"
},
"evaluationScope": {
"@id": "housingfax:evaluationScope"
},
"building": {
"@id": "housingfax:building"
},
"candidates": {
"@id": "housingfax:candidates",
"@container": "@list"
},
"availableNumbers": {
"@id": "housingfax:availableNumbers",
"@container": "@list"
},
"resolutionToken": {
"@id": "housingfax:resolutionToken"
},
"resolutionExpiresInSeconds": {
"@id": "housingfax:resolutionExpiresInSeconds"
},
"ieeAvailability": {
"@id": "housingfax:ieeAvailability"
},
"availableTiers": {
"@id": "housingfax:availableTiers",
"@container": "@list"
},
"notice": {
"@id": "housingfax:notice",
"@type": "xsd:string"
},
"CreateFreeReportOutput": "housingfax:CreateFreeReportOutput",
"jobId": {
"@id": "housingfax:jobId",
"@type": "xsd:string"
},
"statusToken": {
"@id": "housingfax:statusToken",
"@type": "xsd:string"
},
"previewUrl": {
"@id": "housingfax:previewUrl",
"@type": "xsd:string"
},
"pollAfterSeconds": {
"@id": "housingfax:pollAfterSeconds",
"@type": "xsd:integer"
},
"emailNotice": {
"@id": "housingfax:emailNotice",
"@type": "xsd:boolean"
},
"CreateFreeReportInput": "housingfax:CreateFreeReportInput",
"consentStatementSha256": {
"@id": "housingfax:consentStatementSha256",
"@type": "xsd:string"
},
"email": {
"@id": "housingfax:email",
"@type": "xsd:string"
},
"GetJobStatusOutput": "housingfax:GetJobStatusOutput",
"stage": {
"@id": "housingfax:stage"
},
"queuePosition": {
"@id": "housingfax:queuePosition",
"@type": "xsd:integer"
},
"estimatedSeconds": {
"@id": "housingfax:estimatedSeconds",
"@type": "xsd:integer"
},
"withLimitations": {
"@id": "housingfax:withLimitations",
"@type": "xsd:boolean"
},
"errorCode": {
"@id": "housingfax:errorCode",
"@type": "xsd:string"
},
"payment": {
"@id": "housingfax:payment"
},
"PurchaseReportOutput": "housingfax:PurchaseReportOutput",
"orderId": {
"@id": "housingfax:orderId",
"@type": "xsd:string"
},
"tier": {
"@id": "housingfax:tier",
"@type": "xsd:string"
},
"name": {
"@id": "housingfax:name",
"@type": "xsd:string"
},
"priceCents": {
"@id": "housingfax:priceCents",
"@type": "xsd:integer"
},
"price": {
"@id": "housingfax:price",
"@type": "xsd:string"
},
"checkoutUrl": {
"@id": "housingfax:checkoutUrl",
"@type": "xsd:string"
},
"checkoutExpiresAt": {
"@id": "housingfax:checkoutExpiresAt",
"@type": "xsd:dateTime"
},
"reportUrl": {
"@id": "housingfax:reportUrl",
"@type": "xsd:string"
},
"termsVersion": {
"@id": "housingfax:termsVersion",
"@type": "xsd:string"
},
"agentContractingTermsUrl": {
"@id": "housingfax:agentContractingTermsUrl",
"@type": "xsd:string"
},
"PurchaseReportInput": "housingfax:PurchaseReportInput",
"freeReport": {
"@id": "housingfax:freeReport"
},
"acceptTerms": {
"@id": "housingfax:acceptTerms",
"@type": "xsd:boolean"
},
"waiveWithdrawalRight": {
"@id": "housingfax:waiveWithdrawalRight",
"@type": "xsd:boolean"
},
"AgentApiError": "housingfax:AgentApiError",
"error": {
"@id": "housingfax:error"
}
},
"@type": "schema:Dataset",
"schema:name": "HOUSINGFAX API JSON-LD context",
"schema:description": "A JSON-LD @context for the objects HOUSINGFAX's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-11-11) from openapi/_original/housingfax-com-api-openapi.json.",
"dcterms:created": "2026-11-11",
"dcterms:source": [
"openapi/_original/housingfax-com-api-openapi.json"
]
}