OpenAPI Specification

Interactive API documentation powered by OpenAPI 3.0 (Swagger)

Download OpenAPI Spec

Generate client libraries, import into API tools, or use for documentation

download Download JSON download Download YAML (Coming Soon)

What's Included

description

Complete API Definition

Full OpenAPI 3.0 specification with all endpoints, parameters, and response schemas

code

Code Generation Ready

Generate client SDKs in any language using OpenAPI generators

integration_instructions

Tool Integration

Import into Postman, Insomnia, or any OpenAPI-compatible tool

Usage Examples

terminal Generate Client SDK

Use OpenAPI Generator to create client libraries:

bash

# Install OpenAPI Generator
npm install -g @openapitools/openapi-generator-cli

# Generate Python client
openapi-generator-cli generate \
  -i https://www.perilpulse.com/openapi/perilpulse-openapi.json \
  -g python \
  -o ./perilpulse-python-client

# Generate JavaScript client
openapi-generator-cli generate \
  -i https://www.perilpulse.com/api/perilpulse-openapi.json \
  -g javascript \
  -o ./perilpulse-js-client

import_export Import to Postman

Import the OpenAPI spec directly into Postman:

Open Postman and click "Import"
Select "Link" tab
Paste: https://www.perilpulse.com/openapi/perilpulse-openapi.json
Click "Continue" → "Import"

schema Validate Responses

Use the spec to validate API responses:

javascript

const OpenAPIValidator = require('express-openapi-validator');

// Validate responses against the spec
const validator = OpenAPIValidator.middleware({
  apiSpec: 'https://www.perilpulse.com/openapi/perilpulse-openapi.json',
  validateResponses: true
});

Specification Details

Endpoints

GET /risks
GET /enhanced_property_data
GET /replacement_cost_data (Coming Soon)
GET /risks_and_enhanced_property (Coming Soon)
+ Schema endpoints

Features

check OpenAPI 3.0.3 compliant
check Complete parameter validation
check Response schema definitions
check Security scheme documentation
check Error response examples

Need Help?

Check out our API documentation or contact our support team

View API Docs Get Postman Collection Contact Support