API reference

Get a quote for protocol cover

A successful response contains a list of quotes in

• USDC (supported on Ethereum, Base, Arbitrum, Optimism, Polygon)

• ETH (supported on Ethereum, Base, Arbitrum, Optimism)

• cbBTC (supported on Ethereum, Base)

• USDT (supported on Ethereum, Arbitrum, Optimism, Polygon)

Additionally, an EIP-191 signature (version code 0x45) is added to each quote and serves as verification when the quote is submitted to the Quote contract on L2.

post

Returns signed protocol cover quotes for the given parameters.

Body

application/json

productIdnumberRequired

Protocol to cover.

Example: 269

expirynumber · min: 30 · max: 180Required

The number of days a cover should be valid for, e.g. 30, 60, 90 or greater up to 180

Example: 30

integratorIdnumberRequired

Unique integrator ID assigned by OpenCover that enables sales tracking and cover NFT customization.

Example: 4

mintTostringOptional

Destination wallet address for the proof-of-cover NFT. If not specified, the NFT will be minted to the same wallet address that submitted the quote.

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045Pattern: ^0x[0-9a-fA-F]{40}$

coveredAddressesstring[]Required

If requesting a quote to cover an Ecosystem product, the coveredAddresses array must include all user wallet addresses to be covered. For all Non-Ecosystem products, provide an empty array [], as all wallets controlled by the user are automatically covered.

Responses

200

Success response with quote information.

application/json

providerIdnumberOptional

Cover provider ID, allowed value: 255 for Nexus Mutual.

Example: 255

productIdnumberOptional

Requested protocol to cover.

Example: 269

expirynumberOptional

Requested number of days a cover should be valid for.

Example: 30

validUntilnumberOptional

Unix timestamp until the quote is valid.

Example: 1741964280

coveredAddressesstring[]Optional

The wallet addresses included in the coverage for this quote; for Ecosystem products, this reflects the addresses submitted by the requester, while for Non-Ecosystem products, it will be an empty array [] indicating that all user-controlled wallets are covered by default.

Example: []

integratorIdnumberOptional

Requested integrator ID

Example: 1

mintTostringOptional

Requested destination address for proof-of-cover NFT delivery.

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

400

Failed to get a quote for cover.

application/json

500

Internal server error.

application/json

post

/api/quote

HTTPcURLJavaScriptPython

POST /api/quote HTTP/1.1
Host: opencover.com
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "productId": 269,
  "expiry": 30,
  "integratorId": 4,
  "mintTo": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "coveredAddresses": [],
  "amount": {
    "currency": {
      "symbol": "USDC"
    },
    "value": "1000"
  }
}

{
  "providerId": 255,
  "productId": 269,
  "cover": {
    "currency": {
      "code": "usd-coin",
      "symbol": "USDC",
      "decimals": 6,
      "assetId": 2
    },
    "value": "1000000000"
  },
  "displayQuote": {
    "premium": {
      "currency": {
        "code": "usd",
        "symbol": "USD",
        "decimals": 2
      },
      "value": "4.13"
    },
    "fee": {
      "currency": {
        "code": "usd",
        "symbol": "USD",
        "decimals": 2
      },
      "value": "0"
    },
    "discount": {
      "currency": {
        "code": "usd",
        "symbol": "USD",
        "decimals": 2
      },
      "value": "0.2",
      "deal": "OPENCOVER_VIP"
    }
  },
  "quotes": [
    {
      "premium": {
        "currency": {
          "code": "usd-coin",
          "symbol": "USDC",
          "decimals": 6,
          "assetId": 2
        },
        "value": "4136202"
      },
      "fee": {
        "currency": {
          "code": "usd-coin",
          "symbol": "USDC",
          "decimals": 6,
          "assetId": 2
        },
        "value": "0"
      },
      "signature": {
        "v": 28,
        "r": "0x7002f95de6fdba32e2005c8604755f955e82d30792e29c8c9ead1fbacf901949",
        "s": "0x60dce2043e99f24e0fb6a8bd0b4e1e752d37ccf6c8daf2a9cb5ef398b4a1a695"
      }
    },
    {
      "premium": {
        "currency": {
          "code": "ethereum",
          "symbol": "ETH",
          "decimals": 18,
          "assetId": 0
        },
        "value": "2269147850723159"
      },
      "fee": {
        "currency": {
          "code": "ethereum",
          "symbol": "ETH",
          "decimals": 18,
          "assetId": 0
        },
        "value": "0"
      },
      "signature": {
        "v": 27,
        "r": "0xdedcb351f95614548025ab81d28aadf74310e9ef16bf5c98c508ebb52e0407d1",
        "s": "0x77a31843e2bc8798016e9a6a4bd4b2f694fb0c21b165dabeb839358b639d4094"
      }
    },
    {
      "premium": {
        "currency": {
          "code": "coinbase-wrapped-btc",
          "symbol": "cbBTC",
          "decimals": 8,
          "assetId": 5
        },
        "value": "4928"
      },
      "fee": {
        "currency": {
          "code": "coinbase-wrapped-btc",
          "symbol": "cbBTC",
          "decimals": 8,
          "assetId": 5
        },
        "value": "0"
      },
      "signature": {
        "v": 28,
        "r": "0xd569fe6b355e11eff10d83f9d3b4a0ca3a22837085890c494b2990fdcc13a7d5",
        "s": "0x5da29e8c3f16331cdc4fb57208238cded36f45253a4ff152c74a3660a7967c94"
      }
    }
  ],
  "expiry": 30,
  "validUntil": 1741964280,
  "coveredAddresses": "[]",
  "integratorId": 1,
  "mintTo": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
}

List quotes and their statuses for a wallet address

This endpoint allows for retrieving all quotes associated with a specific wallet address, making it simple to track coverage status.

Understanding quote statuses

The response includes quotes in various states, each identified by its quoteStatus:

• QUOTE_AWAITING_SETTLEMENT The quote has been submitted awaiting settlement by OpenCover.

• COVER_ACTIVE Coverage is currently in force.

• COVER_EXPIRED The coverage period has ended.

• QUOTE_EXPIRED The quote was not settled within 24 hours, refund is available.

• QUOTE_REFUNDED The premium payment was returned to the payer.

For more details on the possible states please see the Quote lifecycle page.

These statuses refresh in real-time as actions occur onchain, allowing to monitor the coverage without needing to manually check each transaction.

Each returned quote contains details about the covered product, coverage amount, premium paid, and key timestamps including coverExpiresAt (when coverage ends). Note that settledAt and coverExpiresAt will be null for quotes that are awaiting settlement or refunded.

get

Returns the list of quotes and their statuses for a given wallet address.

Query parameters

ownerAddressstringRequired

Ethereum wallet address.

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045Pattern: ^0x[0-9a-fA-F]{40}$

Responses

200

A list of quotes for the specified owner address.

application/json

400

Invalid owner address provided.

application/json

500

Internal server error.

application/json

get

/api/quotes

HTTPcURLJavaScriptPython

GET /api/quotes?ownerAddress=0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 HTTP/1.1
Host: opencover.com
Accept: */*

{
  "quotes": [
    {
      "quoteId": 1557,
      "chainId": 8453,
      "product": {
        "id": 269,
        "name": "vfat"
      },
      "coverAsset": {
        "symbol": "USDC",
        "decimals": 6
      },
      "coverAmount": "1900000000",
      "paymentAsset": {
        "symbol": "USDC",
        "decimals": 6
      },
      "premiumAmount": "15718677",
      "feeAmount": "0",
      "coverExpiry": 60,
      "ownerAddress": "0x0C000F9e42D0bbcAA455651e7049a7D8EFE7E31D",
      "payerAddress": "0x0C000F9e42D0bbcAA455651e7049a7D8EFE7E31D",
      "integratorId": 4,
      "submittedAt": "2025-05-20T13:08:55.000Z",
      "quoteStatus": "QUOTE_AWAITING_SETTLEMENT",
      "settledAt": null,
      "coverExpiresAt": null
    },
    {
      "quoteId": 1523,
      "chainId": 8453,
      "product": {
        "id": 182,
        "name": "ExtraFi"
      },
      "coverAsset": {
        "symbol": "USDC",
        "decimals": 6
      },
      "coverAmount": "27500000000",
      "paymentAsset": {
        "symbol": "ETH",
        "decimals": 18
      },
      "premiumAmount": "21527191569447081",
      "feeAmount": "0",
      "coverExpiry": 30,
      "ownerAddress": "0x0C000F9e42D0bbcAA455651e7049a7D8EFE7E31D",
      "payerAddress": "0x0C000F9e42D0bbcAA455651e7049a7D8EFE7E31D",
      "integratorId": 0,
      "submittedAt": "2025-05-12T22:45:43.000Z",
      "quoteStatus": "COVER_ACTIVE",
      "settledAt": "2025-05-13T21:04:19.000Z",
      "coverExpiresAt": "2025-06-12T21:04:08.000Z"
    },
    {
      "quoteId": 850,
      "chainId": 8453,
      "product": {
        "id": 182,
        "name": "ExtraFi"
      },
      "coverAsset": {
        "symbol": "USDC",
        "decimals": 6
      },
      "coverAmount": "47000000000",
      "paymentAsset": {
        "symbol": "USDC",
        "decimals": 6
      },
      "premiumAmount": "199808481",
      "feeAmount": "0",
      "coverExpiry": 30,
      "ownerAddress": "0x0C000F9e42D0bbcAA455651e7049a7D8EFE7E31D",
      "payerAddress": "0x0C000F9e42D0bbcAA455651e7049a7D8EFE7E31D",
      "integratorId": 0,
      "submittedAt": "2024-10-20T18:29:01.000Z",
      "quoteStatus": "COVER_EXPIRED",
      "settledAt": "2024-10-21T19:39:09.000Z",
      "coverExpiresAt": "2024-11-20T19:39:01.000Z"
    }
  ]
}

Enable cover notifications

Check if a user is signed up for notifications

This GET endpoint returns the user's email address registered for OpenCover notifications. If the X-OC-Signature HTTP header is not included in the request, the response returns an obfuscated version of the email which is helpful for visual confirmation without requiring user action.

In this case, the response includes the X-OC-Sign HTTP header, containing a Base64-encoded OpenCover consent message. The user signs this message and sends the resulting signature in the X-OC-Signature header to the same GET or POST endpoints.

Special HTTP response status codes 401 and 404 also return the X-OC-Sign header for signature generation (see the Responses section below).

get

Check if a user is signed up for notifications

Path parameters

addressstringRequired

User’s wallet address.

Example: 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

chainIdinteger · enumRequired

Chain ID of the provided network.

Possible values:

Header parameters

X-OC-SignaturestringOptional

User signature for retrieving full email.

Responses

200

Success response with user information.

application/json

400

Missing or malformed information in request body.

application/json

401

User needs to re-sign the OpenCover consent message to continue receiving notifications.

application/json

404

User not found.

application/json

500

Internal server error.

application/json

get

/api/user/{address}/{chainId}

HTTPcURLJavaScriptPython

GET /api/user/{address}/{chainId} HTTP/1.1
Host: opencover.com
Accept: */*

{
  "code": "OK",
  "result": {
    "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "chainId": 8453,
    "email": "e***@e***.c**"
  }
}

Show the full email address

To view their full, non-obfuscated email, users who signed up for OpenCover notifications must include their signature for the OpenCover consent message in the X-OC-Signature HTTP header and send it to the same GET endpoint described in Check if a user is signed up for notifications.

Sign up or update email address for notifications

This POST endpoint allows the user to sign up for OpenCover email notifications about their cover status or update their email address. A valid signature for the OpenCover consent message must be included in the request. The consent message is returned in the X-OC-Sign response header of the GET endpoint described in Check if a user is signed up for notifications.

post

Sign up or update email address for notifications

Header parameters

X-OC-SignaturestringRequired

A valid signature of the user who signed the OpenCover consent message.

Body

application/json

addressstringRequired

User’s wallet address that purchased a cover.

Example: 0xd2135CfB216b74109775236E36d4b433F1DF507B

chainIdinteger · enumRequired

Chain ID of the network the cover was purchased on.

Possible values:

emailstringRequired

Email address for receiving notifications.

Example: [email protected]

Responses

201

Success response with user information.

application/json

400

Missing or malformed information in request body.

application/json

401

User needs to re-sign the OpenCover consent message to continue receiving notifications.

application/json

500

Internal server error.

application/json

post

/api/user

HTTPcURLJavaScriptPython

POST /api/user HTTP/1.1
Host: opencover.com
X-OC-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "address": "0xd2135CfB216b74109775236E36d4b433F1DF507B",
  "chainId": 8453,
  "email": "[email protected]"
}

{
  "code": "OK",
  "result": {
    "address": "0xd2135CfB216b74109775236E36d4b433F1DF507B",
    "chainId": 8453,
    "email": "[email protected]"
  }
}