Bring vPlan AR plans into your software

What your software can read

The same numbers the vPlan editor shows and prints, measured the same way, so your users stop keying room sizes in by hand.

Projects and their measured rooms

Each project’s details (client, property address, date, inspector, claim or job number) and every room with its area by square-footage category, floor area less openings, ceiling height, length and width, wall area before and after doors and windows, baseboard length, door and window counts, finishes and recorded damage. Stairs come with their IRC or IBC checks. See the project summary.

Room-by-room measurement sheets

Every wall run of every room with its length and wall area, each door, window and opening with its size and the mark it has on the printed plan, and totals per level and for the project, as JSON, CSV or an Excel workbook. Rooms come in the order estimators key them in. See measurements.

The plan itself

Each level’s walls, rooms, doors, windows, openings, furniture, stairs and annotations as JSON in metres, with each level’s elevation, ceiling height and place in the building. Enough to redraw the plan in your own product. See plan JSON.

Files, made by the same exporters as the app

The PDF plan set (true-scale sheets with dimensions, room tags and photos), DXF for CAD, IFC for BIM tools, glTF and OBJ 3D models and XML, for one level or all of them. Attach them to a claim or job without asking the user to download and upload. See exports.

Writing back

With the projects:write scope your software can create a vPlan project from plan JSON, rename it and fill in its details, so a job opened in your system can arrive in vPlan with its address and claim number already filled in. See creating projects.

How a connection works

A connection runs on your customer’s own vPlan account. There is no app to register with us and nothing to wait for.

Your customer creates a key

The API is part of the Business plan. In the vPlan web app, under Settings → API & Developer, your customer creates a key, picks only the scopes your integration needs (projects:read, projects:write, exports:read) and a lifetime, and pastes it into your product. The key reads and writes that account’s projects only, and they can revoke it at any time.

You hear about changes instead of polling

Your customer adds your endpoint under Settings → API & Developer → Webhooks, up to 5 per account. vPlan then sends a signed POST when a project is created, when its plan, levels, name or details change (at most every 10 minutes per project while someone is editing), and when an export is made, from the web editor or the iPhone app. Each event names the project; fetch what you need with the API. See webhooks.

Limits you can plan for

Each key can make 60 requests a minute, with lower limits for writes and PDF printing. Responses carry error codes your software can act on, such as an expired key or a missing scope, and a Retry-After header when a limit is reached. See errors and limits.

Build and test

Start from real responses, then test against a live account.

Sample API responses

The sample files below are what the API returns today for vPlan’s sample house: seven rooms, 1,320 sq ft of gross living area, finishes and a water damage claim on two rooms. They are generated by the same code that answers API requests, and our test suite fails if the two ever differ, so they don’t go stale. Use them to map fields and write your parser before anyone has a key.

The full reference

Every endpoint, parameter, field, error code and limit is documented on the API reference, with examples you can paste into a terminal.

A live account for development

There is no separate sandbox. To test against live endpoints, use a Business account with a project or two scanned or drawn in it. If you are building an integration for your customers, email us and tell us what you’re building, and we’ll talk about an account for development.

Open formats, no integration needed

Many tools can already take vPlan output without any code, because the exports are standard files.

CAD and BIM

DXF with real units and AIA-style layers for AutoCAD and other CAD tools (Pro), and IFC4 for Revit, ArchiCAD and other BIM tools, with the same element ids on every export so a re-import updates (Business).

3D

glTF (GLB), OBJ and USDZ models with walls cut at doors and windows, floors and furniture, for Blender, SketchUp, game engines and AR Quick Look on iPhone and iPad (Pro).

Spreadsheets and data

Room, door, window and finish schedules and room-by-room measurement sheets as Excel or CSV (Pro), and the whole plan as structured XML (Business). PDF plan sets come with every plan.

What our users ask for

vPlan doesn’t send plans straight to Xactimate, Symbility, CoreLogic / Cotality or other estimating platforms today. Users can ask for one from Export in the editor, and we count every request.

Estimating and claims platforms

The request form sits in the editor’s Export panel, for adjusters, restoration contractors and estimators who key room measurements into estimating software by hand. Until there is a direct connection, the Measurement Sheets export lays every room out wall run by wall run for them. If your company makes one of these platforms, or a tool these users work in, we’d like to hear from you. vPlan AR isn’t affiliated with Xactimate, Symbility, CoreLogic / Cotality; the names are their owners’ trademarks.

Job management, photo documentation and project management

Restoration and field-service job management, photo documentation and contractor project management are where vPlan projects end up. These platforms can connect today with the API and webhooks above, without anything from us.

Sample responses

What the API returns for the sample house. The project id and dates are placeholders; everything else is the API’s real output.

• GET /api/v1/projects/{id}

  Project details, levels and every room measured: area by category, wall area, baseboard, doors, windows, finishes and damage.

  JSON

• GET /api/v1/projects/{id}/plan

  Each level’s plan as JSON: walls, rooms, doors, windows, furniture and annotations in metres.

  JSON

• GET /api/v1/projects/{id}/measurements

  Room-by-room measurements: each wall run, ceiling height, floor, wall and ceiling areas, perimeter and openings.

  JSON

Ask your software vendor

Use vPlan AR and want your plans to land in your claims, job or estimating software? The company that makes it decides what it connects to, and requests from their own customers are what move it up their list. Send them this note.