BIMR API / Capability showcase

Your building.
Your software.

From 2D drawings to 3D BIM. From building records to useful answers. Bring the BIMR engine into the tools your customers already use.

API design showcase. This catalogue combines existing BIMR capabilities with proposed services. The endpoints are illustrative, not a released public API. Enquiries open your email client; this page does not place orders.

2D → 3D BIMStandalone file delivery17 service families

01 / A building model, ordered through your application

An address in.
A BIM file out.

Service design

Let a homeowner, architect or company order a model of a real building. Supply the address and intended use. The proposed service coordinates drawing retrieval, runs the BIMR engine and delivers an IFC package directly to the buyer. No BIMR app subscription required.

1–5 working days

Target from order confirmation for eligible buildings. The quote confirms scope and expected delivery. Archive delays, scans, missing drawings or additional review can extend the time.

  1. 01

    Identify

    Address, property reference, the right building and the buyer's intended use.

  2. 02

    Request

    A BIMR agent coordinates archive correspondence and follows up within the approved scope.

  3. 03

    Receive

    Replies and drawings join the order record. Sheets, revisions and source rights are checked.

  4. 04

    Build & review

    The BIMR engine creates the supported geometry. Coverage and assumptions are reviewed.

  5. 05

    Deliver

    IFC files, a preview, room data and a quality report go to the approved recipient.

Explore a fictional order

Keep your customer informed at every step.

An archive question, a missing floor plan or a fee request becomes a visible order state. Your customer can follow progress in your application and receive the final files directly.

Select a stage to explore an example. No request is sent and no file is generated.

Discuss a building order
Example House / Building AFictional order

Archive request prepared

Find the building's drawings.

A request identifies the property, floors and drawing types, with a reply reference and an agreed fee ceiling.

  • Floor plans, sections and elevations requested
  • Archive questions linked to this order
  • Extra fees require approval

Illustrative state. No archive has been contacted.

Example API responseGET /v1/bim-orders/example-order-001
{
  "example": true,
  "order_id": "example-order-001",
  "status": "archive_request_prepared",
  "app_subscription_required": false,
  "target": {
    "min_working_days": 1,
    "max_working_days": 5,
    "starts_at": "order_confirmation",
    "guaranteed": false
  },
  "deliverables": []
}

Have the drawings?

Use the BIMR engine directly.

Selected vector PDF plans can become draft architectural IFC models with source-linked geometry. An API job would package that engine for your own workflow.

Explore 2D-to-3D endpoints

Need the drawings?

Add the acquisition service.

The proposed order flow combines archive correspondence, document intake and model delivery. Scans and incomplete sets need a qualified reconstruction or specialist review path.

Explore archive endpoints

A drawing-derived model describes the available drawings. Current dimensions and installations may need site verification. Stockholm's archive guidance explains this distinction; Malmö publishes about a week for document handling. Archive release and reconstruction time are separate.

02 / Explore what your application could offer

One engine.
Many useful services.

Explore 109 proposed endpoints across 17 service families. Open a family to see the customer outcome, example route and what it depends on.

BIMR foundation

Underlying functionality exists in BIMR. External API packaging and validation are still required.

Service design

A proposed service requiring new engineering or an operational workflow.

Partner data

Requires vendor data, a customer connection or an agreed source licence, plus integration work.

Network data

Requires enough comparable, permitted observations. Customer scale is not assumed.

All 109 endpoint designs

Download catalogue JSON
01Order a BIM of your buildingA standalone building-to-file service, with no BIMR app subscription required.8 endpoints

For homeowners, building owners, architects, surveyors, software platforms

Order orchestration, archive intake, pricing, review and direct delivery need implementation. Target: 1–5 working days for eligible orders from confirmation; the quote must give an expected delivery date.

Check scope and get a quote

Service design

Building identity, available drawings, intended use, model detail, estimated fees and delivery target.

POST /v1/bim-orders/quotes

Place a standalone BIM order

Service design

Create an order against an accepted quote, authorized use and named recipients.

POST /v1/bim-orders

Track your order

Service design

See archive progress, missing information, review state and the current delivery estimate.

GET /v1/bim-orders/{order_id}

Add your own drawings

Service design

Contribute permitted files to the same order, even while archive retrieval is underway.

POST /v1/bim-orders/{order_id}/documents

Approve an order change

Service design

Approve extra archive fees, revised scope or delivery timing explicitly.

POST /v1/bim-orders/{order_id}/approvals

Request cancellation

Service design

Return cancellation eligibility, incurred work and the applicable refund decision.

POST /v1/bim-orders/{order_id}/cancellation

Collect your model package

Service design

Authorized IFC download, preview, room schedule and a report of sources, coverage and assumptions.

GET /v1/bim-orders/{order_id}/deliverables

Deliver to your customer

Service design

Send the approved package to a named recipient by secure link, with delivery status.

POST /v1/bim-orders/{order_id}/deliveries
02Drawing acquisition & archive correspondenceCoordinate the search, correspondence and receipt of actual building drawings.6 endpoints

For owners, property managers, archive services

Municipality-specific access, a configured mailbox, fee authority and release decisions are required. The workflow includes human handling for login, restrictions and ambiguous replies.

Check an archive route

Service design

Verified municipality contact, available request method and the date it was checked.

GET /v1/archives/coverage

Request archive drawings

Service design

A tracked request for the selected property, sheet types and permitted fee ceiling.

POST /v1/drawing-requests

Follow retrieval

Service design

Distinguish requested, received, partial, not found, restricted and needs-action states.

GET /v1/drawing-requests/{request_id}

Read the correspondence

Service design

A permission-controlled thread linking archive questions, replies and attachments.

GET /v1/drawing-requests/{request_id}/messages

Continue the conversation

Service design

An authorized reply or agent-assisted clarification, retained with the request.

POST /v1/drawing-requests/{request_id}/replies

Collect received drawings

Service design

Original files linked to the request, source, building candidates and review status.

GET /v1/drawing-requests/{request_id}/documents
032D to 3D with the BIMR engineTurn supported 2D drawings into an editable architectural IFC model.8 endpoints

For architects, bim consultants, owners, renovation teams

The engine exists for selected vector PDFs. API jobs, complete drawing-set assembly and raster reconstruction need additional work; each result needs a stated coverage and review status.

Check a drawing set

Service design

Supported input types, usable scale, missing floors or sections and a proposed model scope.

POST /v1/reconstructions/preflight

Convert a drawing to BIM

BIMR foundation

A draft IFC from supported vector plans, with rooms, walls, openings and recorded assumptions.

POST /v1/reconstructions

Follow model generation

Service design

Processing stage and errors, independently from model coverage and review acceptance.

GET /v1/reconstructions/{job_id}

Download the reconstruction

Service design

IFC, room schedule, source references and model-quality findings in one output contract.

GET /v1/reconstructions/{job_id}/outputs

Understand each element

BIMR foundation

Which geometry came from a drawing, construction practice or an explicit assumption.

GET /v1/reconstructions/{job_id}/provenance

Record a model review

Service design

Accepted corrections, reviewer identity and remaining limitations for this revision.

POST /v1/reconstructions/{job_id}/reviews

Build across floors and files

Service design

A coordinated architectural model using compatible plans, sections and revision choices.

POST /v1/drawing-sets/{set_id}/reconstructions

Reconstruct scanned plans

Service design

A proposed scan-to-BIM service requiring a validated raster pipeline and geometric review.

POST /v1/raster-reconstructions
04IFC processing & model intelligenceUse BIM models and their structured contents inside your own software.8 endpoints

For software teams, designers, estimators, facility managers

IFC conversion and object queries have an existing foundation. New exports, comparison and review services need validation against model contents and units.

Process an IFC file

BIMR foundation

A browser-ready model and indexed elements from a customer-authorized IFC.

POST /v1/models

Query building elements

BIMR foundation

Filter actual model objects and return identifiers, classes and available properties.

GET /v1/models/{model_id}/elements

Read rooms and storeys

BIMR foundation

A room and floor register with model references and available quantities.

GET /v1/models/{model_id}/spaces

Explore building systems

BIMR foundation

Discover the systems actually present in the model and their connected elements.

GET /v1/models/{model_id}/systems

Extract quantities

BIMR foundation

Available areas, lengths, volumes and counts with units and measurement provenance.

GET /v1/models/{model_id}/quantities

Compare model revisions

Service design

Added, removed and changed objects, including unresolved identity matches.

POST /v1/model-comparisons

Check handover information

Service design

Missing properties and documents against the customer's stated requirements.

POST /v1/model-checks

Embed a model view

Service design

A permission-scoped view of selected models or objects with an expiry and revocation path.

POST /v1/model-views
05Drawing sets, revisions & 2D outputsKeep the original drawings useful alongside the model.6 endpoints

For architects, contractors, surveyors, maintenance teams

Sheet classification, revision reconciliation and generated 2D outputs need new packaging and validation. Derived drawings retain their source limitations.

Organize a drawing package

Service design

An inventory of sheets, floors, disciplines, dates and source files.

POST /v1/drawing-sets

Find missing drawings

Service design

Missing floors, sections and references against the agreed building scope.

GET /v1/drawing-sets/{set_id}/coverage

See drawing history

Service design

Current, superseded and unresolved sheet versions with the review decision.

GET /v1/drawing-sets/{set_id}/revisions

Compare drawing revisions

Service design

Candidate geometry and annotation changes for a reviewer to verify.

POST /v1/drawing-comparisons

Export a model floor plan

Service design

A proposed PDF or SVG plan with scale and the model revision identified.

POST /v1/models/{model_id}/floor-plan-exports

Create a model section

Service design

A selected cut through the available geometry with source and limitation notes.

POST /v1/models/{model_id}/section-exports
06Building identity & portfolio recordsConnect the same physical building across documents, models and business systems.7 endpoints

For owners, brfs, property managers, public property teams

Customer mandates and upstream entitlements govern access. A property can contain several buildings; an address match alone must not silently merge them.

Find the right building

BIMR foundation

Address or property-reference candidates with ambiguity and source information.

POST /v1/buildings/resolve

Read the building record

BIMR foundation

Known facts, linked models and documents, dates and unresolved information.

GET /v1/buildings/{building_id}

Correct building information

BIMR foundation

An authorized correction with the previous value and source retained.

PATCH /v1/buildings/{building_id}

Import a portfolio

Service design

Reconcile your building list, external IDs and owner groups without duplicates.

POST /v1/portfolio-imports

List permitted buildings

BIMR foundation

The buildings in the selected owner or manager scope, including incomplete identities.

GET /v1/portfolios/{portfolio_id}/buildings

Find an owner's holdings

Partner data

A separately entitled register lookup with price, mandate and permitted use checked first.

POST /v1/ownership-lookups

See information gaps

Service design

A collection list for missing facts, drawings, documents and equipment records.

GET /v1/buildings/{building_id}/coverage
07Document intelligence & building questionsTurn a building binder into searchable records with evidence attached.6 endpoints

For property software, managers, inspectors, administrators

Existing extraction supports selected document types. Answers require access to the cited originals; scans readable as text are not automatically reconstructable as geometry.

Ingest building documents

BIMR foundation

Stored originals, document classification and candidate building links.

POST /v1/documents

Read extracted facts

BIMR foundation

Typed facts, source pages, confidence and review state for supported reports and invoices.

GET /v1/documents/{document_id}/extractions

Open the source

BIMR foundation

Authorized access to the original file behind a claim or extracted value.

GET /v1/documents/{document_id}/original

Search permitted evidence

Service design

Relevant passages and source references within explicitly selected buildings.

POST /v1/document-searches

Ask a building question

BIMR foundation

A cited answer from permitted building records, with unknowns kept visible.

POST /v1/building-questions

Correct an extraction

Service design

A reviewed value linked to the original extraction and the responsible reviewer.

POST /v1/documents/{document_id}/reviews
08Building history & asset recordsRetain the building's documented history through changes of staff and systems.5 endpoints

For owners, new managers, contractors, accountants

A reported action, a paid invoice and accepted completion remain distinct. Dates and installed-product identity need source evidence.

Read the building timeline

BIMR foundation

Dated inspection, renovation and work records with their supporting documents.

GET /v1/buildings/{building_id}/history

Add a documented event

BIMR foundation

A sourced action linked to the building, system or known model element.

POST /v1/buildings/{building_id}/events

Read the component register

Service design

Documented roof, window and other component records, dates and information gaps.

GET /v1/buildings/{building_id}/components

Follow an installed asset

Service design

Installation, service and replacement evidence for a confirmed asset identity.

GET /v1/assets/{asset_id}/history

Prepare a portable handover

Service design

Authorized originals, model revisions, identifiers and history for a named successor.

POST /v1/building-handovers
09Inspections, maintenance & field workConnect the finding, the work and the evidence of completion.8 endpoints

For contractors, inspectors, residents, property managers

External write operations need delegated scope and delivery controls. Due dates need an applicable rule and supporting facts; records do not certify legal compliance.

Read inspection requirements

BIMR foundation

Supported obligations, their basis, due dates and missing inputs.

GET /v1/buildings/{building_id}/obligations

Connect the work calendar

BIMR foundation

Scheduled inspections and work, including unresolved dependencies.

GET /v1/portfolios/{portfolio_id}/calendar

Create a scoped work package

BIMR foundation

Selected locations, relevant model objects, requirements and permitted documents.

POST /v1/work-orders

Submit field evidence

BIMR foundation

Photos, measurements and a contractor's completion report attached to the job.

POST /v1/work-orders/{work_order_id}/evidence

Record owner acceptance

Service design

The owner's separate decision on the submitted work and any remaining issues.

POST /v1/work-orders/{work_order_id}/acceptance

Prepare a finding response

Service design

Finding-by-finding evidence linking corrective work to the original inspection.

POST /v1/inspection-closeouts

Receive occupant reports

Service design

A fault report restricted to the reporter's permitted building or space.

POST /v1/issue-reports

Coordinate site visits

Service design

Conflicting visits, access requirements and acknowledgments within an authorized portfolio.

POST /v1/visit-coordination-checks
10Invoices, contracts & maintenance budgetsMake building expenditure traceable to agreements and documented work.6 endpoints

For financial managers, accountants, owners, engaged suppliers

Use the customer's own agreements and costs. Accounting decisions require review; external accounting sync and supplier access need separately authorized connections.

Check an invoice

BIMR foundation

Arithmetic and matched-line exceptions against the customer's own agreed prices.

POST /v1/invoice-checks

Match work to a bill

Service design

Differences between authorized scope, submitted evidence, acceptance and invoiced work.

POST /v1/work-invoice-reconciliations

Check a draft supplier bill

Service design

An engaged supplier checks only the contract and job scope explicitly shared with it.

POST /v1/supplier-invoice-prechecks

Compare maintenance options

Service design

Timing and quantity scenarios using documented costs and explicit assumptions.

POST /v1/maintenance-scenarios

Draft investment allocations

Service design

Source-linked component dates and costs for an accountant to review.

POST /v1/component-register-drafts

Send an approved accounting package

Partner data

Reviewed records mapped to the customer's ledger and connected accounting system.

POST /v1/accounting-exports
11Energy, weather & connected equipmentGive consumption a building, a period and a clear comparison basis.7 endpoints

For owners, energy consultants, utilities, facility managers

Area definitions, estimated readings and weather methods stay visible. Continuous meter or BMS data needs a customer-authorized provider connection.

Import consumption records

BIMR foundation

Building-linked readings or invoice-derived periods with units and estimate flags.

POST /v1/consumption-imports

Read energy and water use

BIMR foundation

A consistent time series with original periods, gaps and source references.

GET /v1/buildings/{building_id}/consumption

Add weather context

BIMR foundation

A qualified weather-adjusted series using a documented method and area basis.

POST /v1/energy-normalizations

Evaluate a renovation period

Service design

Before-and-after consumption with weather, occupancy and other comparison limits.

POST /v1/retrofit-reports

Plan weather-sensitive work

Service design

Relevant weather signals linked to documented exposure and planned activities.

GET /v1/buildings/{building_id}/weather-alerts

Connect a meter

Partner data

An authorized meter-to-building mapping, provider details and feed health.

POST /v1/meter-connections

Read connected equipment

Partner data

Authorized time series and alarms with units, timestamps and missing-data indicators.

GET /v1/assets/{asset_id}/telemetry
12Products, service & supplier connectionsConnect a known installation to the information and service it needs.8 endpoints

For manufacturers, distributors, installers, service companies

Manufacturer data, supplier contracts and confirmed asset identities are required for product-specific claims. No catalogue access implies access to the customer base.

Match purchase records

BIMR foundation

Candidate links between the customer's purchased items and model elements, awaiting confirmation.

POST /v1/purchase-imports

Read a product record

Partner data

Licensed technical properties, identifiers and lifecycle information.

GET /v1/products/{product_id}

Find manuals and warranty terms

Partner data

Documents for a confirmed installed product and the applicable version.

GET /v1/assets/{asset_id}/documents

Find replacement candidates

Partner data

Compatibility evidence and required checks for a specified installation.

POST /v1/replacement-part-searches

Check price and availability

Partner data

Current stock, customer-specific price, lead time and the supplier's timestamp.

POST /v1/supplier-availability-checks

Match a product notice

Partner data

Authenticated recall or obsolescence notices matched to confirmed product or serial ranges.

POST /v1/recall-matches

Request service or a quote

Partner data

An owner's approved request sent to selected companies with only the necessary information.

POST /v1/service-requests

Check company information

BIMR foundation

Permitted register facts and source freshness, without an invented certification verdict.

GET /v1/companies/{company_id}/facts
13Materials, carbon & reuseConnect available quantities to documented materials and environmental evidence.4 endpoints

For architects, sustainability teams, manufacturers, reuse partners

Product EPDs and generic factors have different scopes. Model quantities and condition descriptions must be reviewed for the intended assessment or reuse decision.

Estimate material impact

Partner data

Qualified quantities and licensed factors with lifecycle boundaries and uncertainty.

POST /v1/carbon-assessments

Retrieve product EPD evidence

Partner data

The matched declaration, validity period and scope of applicability.

GET /v1/products/{product_id}/environmental-declarations

Prepare a reuse inventory

Service design

Documented components, dimensions, condition and disassembly evidence.

POST /v1/reuse-inventories

Share approved reusable stock

Partner data

A selected inventory sent to an authorized reuse partner under agreed sharing terms.

POST /v1/reuse-listings
14Exterior models & site contextGive a building useful geographic context before interior drawings are available.5 endpoints

For portfolio teams, planners, surveyors, energy designers

Coverage, source dates, geometric meaning and onward-use rights vary by dataset. Exterior geometry cannot establish the interior or the actual condition of a site.

Build an exterior shell

Service design

A footprint-based model using a sourced height or a clearly identified estimate.

POST /v1/exterior-models

Refine exterior geometry

Partner data

A proposed roof model from suitable licensed laser or building geometry, subject to coverage checks.

POST /v1/roof-reconstructions

Read environmental context

Service design

Permitted geological and public context layers with resolution and source dates.

GET /v1/buildings/{building_id}/site-context

Screen a roof for solar

Service design

A preliminary scenario from qualified roof and shading data, with engineering checks identified.

POST /v1/solar-screenings

Create a portfolio map

Service design

An authorized building map with selected facts, source attribution and missing locations counted.

POST /v1/building-map-exports
15Reports, graphs & evidence packagesGive each recipient a useful view of the evidence they are allowed to see.5 endpoints

For boards, banks, insurers, transaction advisers, software teams

Sharing is case-specific and owner-authorized. A report summarizes evidence and gaps; it is not an automated lending, insurance or statutory approval.

Create a building report

Service design

Selected model, condition, maintenance and expenditure records with sources and dates.

POST /v1/building-reports

Prepare a case-specific evidence pack

Service design

Permitted documents and unresolved gaps for a transaction, insurance claim or finance application.

POST /v1/evidence-packages

Generate an information graphic

Service design

A PDF or SVG chart from permitted data, retaining units, source dates and attribution.

POST /v1/chart-exports

Summarize a portfolio

Service design

Comparable measures and exceptions across only the owner's selected buildings.

POST /v1/portfolio-reports

Share with a named recipient

Service design

An expiring, revocable delivery link to a selected report or package.

POST /v1/share-links
16Permissioned portfolio & network insightsMake comparable observations useful as the evidence base grows.4 endpoints

For owners, managers, energy teams, participating manufacturers

Requires sufficient eligible observations, comparable definitions and permission. Public statistical references can support early energy comparisons; there is no demonstrated large customer dataset today.

Compare similar buildings

Network data

Eligible peer or public-reference comparisons with sample size, period and comparability limits.

POST /v1/energy-benchmarks

Explore maintenance patterns

Network data

Historical recurrence and resolution statistics with missing records and cohort limits stated.

POST /v1/maintenance-benchmarks

Study observed asset outcomes

Network data

Qualified reliability and service observations for identified equipment and exposure periods.

POST /v1/equipment-outcome-reports

Compare documented service outcomes

Network data

Eligible descriptive completion and return-visit statistics without exposing customer records or current bids.

POST /v1/service-outcome-reports
17Integration controls & deliveryMake each service usable from another application with bounded access and reliable delivery.8 endpoints

For software vendors, integrators, enterprise it

These are proposed external platform controls. Existing app sessions are not a released machine-to-machine API contract.

Discover entitled services

Service design

The operations and source permissions actually enabled for the calling integration.

GET /v1/capabilities

Create scoped credentials

Service design

Machine access limited to agreed operations, owners and buildings, with an expiry.

POST /v1/integration-credentials

Authorize a recipient or integration

Service design

Explicit building and purpose scope, duration and audit evidence.

POST /v1/access-grants

Revoke a grant

Service design

Stop future access through a specified grant while retaining the required audit record.

DELETE /v1/access-grants/{grant_id}

Subscribe to changes

Service design

Signed delivery events for approved jobs, records and model revisions.

POST /v1/webhook-subscriptions

Poll a background job

Service design

Durable state, retry details and separate processing, coverage and review results.

GET /v1/jobs/{job_id}

Read metered usage

Service design

Itemized operations, agreed unit prices and source charges for the calling customer.

GET /v1/usage

Inspect an integration's activity

Service design

Permitted access, corrections, approvals and deliveries with timestamps and responsible actors.

GET /v1/audit-events

03 / Built around the people who use building information

A file. An integration.
A connected portfolio.

Owners & one-off buyers

A model of your building, a room schedule or a selected evidence package. The proposed order service works without an app subscription.

Software vendors & integrators

Embed model processing, document extraction, charts and building answers in the product your customers already use.

Managers & public property teams

Connect permitted client portfolios, inspections, maintenance history, budgets and reporting.

Architects & field teams

Obtain reviewable geometry, scope work and return inspection or installation evidence to the correct building.

Manufacturers & suppliers

Reach authorized installations with the right manual, product update, part candidate or service response.

Energy, finance & insurance teams

Receive a case-specific view of consumption, documented work and information gaps with the owner's authorization.

Discuss the output you need.

Explore per-file model orders, metered processing, portfolio integrations or partner distribution. Scope, price, source charges and delivery terms are agreed before work starts.

Discuss your integration
Source rights and customer access

Our endpoints, models and graphs still need permission to use their source material. Public access to a drawing does not by itself grant permission to adapt or redistribute it. Vendor datasets follow their specific licences. Customer records are shared only within the agreed purpose and recipient scope; aggregation needs its own basis.

Product connections can distribute approved information to relevant buildings without giving a supplier access to other customers' private records.