Offchain API

This API is used to query information about policies and other components of the protocol.

You can navigate our offchain API at these URLs:

get
Authorizations
AuthorizationstringRequired
Query parameters
e_tokenstringOptional

e_token

block_numberstringOptional

block_number

timestamp_fromstringOptional

timestamp_from

timestamp_tostringOptional

timestamp_to

limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses
chevron-right
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get
/etokenblockshots/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
e_tokenstringOptional

e_token

block_numberstringOptional

block_number

timestamp_fromstringOptional

timestamp_from

timestamp_tostringOptional

timestamp_to

limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses
chevron-right
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get
/etokenblockshots/by_day/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
e_tokenstringOptional

e_token

block_numberstringOptional

block_number

timestamp_fromstringOptional

timestamp_from

timestamp_tostringOptional

timestamp_to

limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses
chevron-right
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get
/etokenblockshots/by_week/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this e token block shot.

Responses
chevron-right
200Success
application/json
idintegerRead-onlyOptional
e_tokenstring · uriRequired
block_numberinteger · min: -2147483648 · max: 2147483647Required
timestampstring · date-timeRequired
total_supplystring · decimalRequired
scrstring · decimalRequired
token_interest_ratestring · decimalRequired
current_scalestring · decimalRequired
get
/etokenblockshots/{id}/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
namestringOptional

name

poolstringOptional

pool

symbolstringOptional

symbol

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
symbolstring · min: 1 · max: 20Required
poolstring · uriRequired
descriptionstringOptional
jr_for_passtring · uri[]Required
sr_for_passtring · uri[]Required
jr_etksstringRead-onlyOptional
sr_etksstringRead-onlyOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/etokens/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
namestringOptional

name

poolstringOptional

pool

symbolstringOptional

symbol

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
symbolstring · min: 1 · max: 20Required
poolstring · uriRequired
descriptionstringOptional
jr_for_passtring · uri[]Required
sr_for_passtring · uri[]Required
jr_etksstringRead-onlyOptional
sr_etksstringRead-onlyOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/etokens/apy_range/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this e token.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
symbolstring · min: 1 · max: 20Required
poolstring · uriRequired
descriptionstringOptional
jr_for_passtring · uri[]Required
sr_for_passtring · uri[]Required
jr_etksstringRead-onlyOptional
sr_etksstringRead-onlyOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/etokens/{address}/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this e token.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
symbolstring · min: 1 · max: 20Required
poolstring · uriRequired
descriptionstringOptional
jr_for_passtring · uri[]Required
sr_for_passtring · uri[]Required
jr_etksstringRead-onlyOptional
sr_etksstringRead-onlyOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/etokens/{address}/apr/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this e token.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
symbolstring · min: 1 · max: 20Required
poolstring · uriRequired
descriptionstringOptional
jr_for_passtring · uri[]Required
sr_for_passtring · uri[]Required
jr_etksstringRead-onlyOptional
sr_etksstringRead-onlyOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/etokens/{address}/apr_history/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this e token.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
symbolstring · min: 1 · max: 20Required
poolstring · uriRequired
descriptionstringOptional
jr_for_passtring · uri[]Required
sr_for_passtring · uri[]Required
jr_etksstringRead-onlyOptional
sr_etksstringRead-onlyOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/etokens/{address}/block_shots/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this e token.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
symbolstring · min: 1 · max: 20Required
poolstring · uriRequired
descriptionstringOptional
jr_for_passtring · uri[]Required
sr_for_passtring · uri[]Required
jr_etksstringRead-onlyOptional
sr_etksstringRead-onlyOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/etokens/{address}/composition_history/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this e token.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
symbolstring · min: 1 · max: 20Required
poolstring · uriRequired
descriptionstringOptional
jr_for_passtring · uri[]Required
sr_for_passtring · uri[]Required
jr_etksstringRead-onlyOptional
sr_etksstringRead-onlyOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/etokens/{address}/liquidity_history/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this e token.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
symbolstring · min: 1 · max: 20Required
poolstring · uriRequired
descriptionstringOptional
jr_for_passtring · uri[]Required
sr_for_passtring · uri[]Required
jr_etksstringRead-onlyOptional
sr_etksstringRead-onlyOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/etokens/{address}/lockup/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this e token.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
symbolstring · min: 1 · max: 20Required
poolstring · uriRequired
descriptionstringOptional
jr_for_passtring · uri[]Required
sr_for_passtring · uri[]Required
jr_etksstringRead-onlyOptional
sr_etksstringRead-onlyOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/etokens/{address}/lps_breakdown/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this e token.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
symbolstring · min: 1 · max: 20Required
poolstring · uriRequired
descriptionstringOptional
jr_for_passtring · uri[]Required
sr_for_passtring · uri[]Required
jr_etksstringRead-onlyOptional
sr_etksstringRead-onlyOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/etokens/{address}/net_deposits/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this e token.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
symbolstring · min: 1 · max: 20Required
poolstring · uriRequired
descriptionstringOptional
jr_for_passtring · uri[]Required
sr_for_passtring · uri[]Required
jr_etksstringRead-onlyOptional
sr_etksstringRead-onlyOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/etokens/{address}/net_deposits_history/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this e token.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
symbolstring · min: 1 · max: 20Required
poolstring · uriRequired
descriptionstringOptional
jr_for_passtring · uri[]Required
sr_for_passtring · uri[]Required
jr_etksstringRead-onlyOptional
sr_etksstringRead-onlyOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/etokens/{address}/pa_scr_breakdown/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this e token.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
symbolstring · min: 1 · max: 20Required
poolstring · uriRequired
descriptionstringOptional
jr_for_passtring · uri[]Required
sr_for_passtring · uri[]Required
jr_etksstringRead-onlyOptional
sr_etksstringRead-onlyOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/etokens/{address}/scr_breakdown/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this e token.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
symbolstring · min: 1 · max: 20Required
poolstring · uriRequired
descriptionstringOptional
jr_for_passtring · uri[]Required
sr_for_passtring · uri[]Required
jr_etksstringRead-onlyOptional
sr_etksstringRead-onlyOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/etokens/{address}/scr_history/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this e token.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
symbolstring · min: 1 · max: 20Required
poolstring · uriRequired
descriptionstringOptional
jr_for_passtring · uri[]Required
sr_for_passtring · uri[]Required
jr_etksstringRead-onlyOptional
sr_etksstringRead-onlyOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/etokens/{address}/ur_history/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
namestringOptional

name

tx__block_numberstringOptional

tx__block_number

contract_addressstringOptional

contract_address

tx__timestamp_fromstringOptional

Tx timestamp is after

tx__timestamp_tostringOptional

Tx timestamp is before

limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses
chevron-right
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get
/events/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this event.

Responses
chevron-right
200Success
application/json
log_indexinteger · min: -2147483648 · max: 2147483647Required
namestring · min: 1 · max: 40Required
contract_addressstringRequired
argsobject · ArgsRequired
get
/events/{id}/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
lpstringOptional

lp

e_tokenstringOptional

e_token

ostring · enumOptional

Ordering

Possible values:
limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses
chevron-right
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get
/lpevents/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
eventstringRequired

A unique value identifying this lp event.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
lpstring · uriRequired
e_tokenstring · uriRequired
event_typestring · enumRequiredPossible values:
amountstring · decimalRequired
get
/lpevents/{event}/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses
chevron-right
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get
/lps/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this lp.

Responses
chevron-right
200Success
application/json
addressstringRequired
get
/lps/{address}/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
rmstringOptional

rm

statusstring · enumOptional

status

Possible values:
ensuro_idstringOptional

ensuro_id

quote_idstringOptional

Quote ID

start_fromstringOptional

Policy start is after

start_tostringOptional

Policy start is before

expiration_fromstringOptional

Policy expiration is after

expiration_tostringOptional

Policy expiration is before

ostring · enumOptional

Ordering

Possible values:
limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses
chevron-right
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get
/policies/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

A unique integer value identifying this policy.

Responses
chevron-right
200Success
application/json
idintegerRead-onlyOptional
urlstring · uriRead-onlyOptional
ensuro_idstring · decimalOptional
rmstring · uriRequired
quotestring · uriOptional
premiumstring · decimalRequired
payoutstring · decimalRequired
loss_probstring · decimalRequired
jr_scrstring · decimalRequired
sr_scrstring · decimalRequired
pure_premiumstring · decimalRequired
ensuro_commissionstring · decimalRequired
partner_commissionstring · decimalRequired
jr_cocstring · decimalRequired
sr_cocstring · decimalRequired
startstring · date-timeRequired
expirationstring · date-timeRequired
statusstring · enumOptionalPossible values:
actual_payoutstring · decimalOptional
replacesstring · uriRequired
replaced_bystring · uriRead-onlyOptional
get
/policies/{id}/
200Success
get
Authorizations
AuthorizationstringRequired
Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
currency_addrstringRequired
access_addrstringRead-onlyOptional
get
/pools/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this pool.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
currency_addrstringRequired
access_addrstringRead-onlyOptional
get
/pools/{address}/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
namestringOptional

name

poolstringOptional

pool

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/active_policies/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/active_policies_history/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/active_premiums/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/active_premiums_history/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/cashflow/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/composition_history/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/gwp/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/gwp_history/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/matured_surplus/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/matured_surplus_history/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/rm_breakdown/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/scr/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/scr_history/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/surplus/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/surplus_history/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this premiums account.

Responses
chevron-right
200Success
application/json
addressstringRequired
urlstring · uriRead-onlyOptional
namestring · min: 1 · max: 40Required
poolstring · uriRequired
descriptionstringOptional
jr_etkstring · uriOptional
sr_etkstring · uriOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/premiumsaccounts/{address}/wonpremiumsinout/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
poolstringOptional

pool

premiums_accountstringOptional

premiums_account

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
poolstring · uriRequired
premiums_accountstring · uriRequired
jr_etkstring · uriRead-onlyOptional
sr_etkstring · uriRead-onlyOptional
descriptionstringOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/riskmodules/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
poolstringOptional

pool

premiums_accountstringOptional

premiums_account

Responses
chevron-right
200Success

No content

get
/riskmodules/total_premiums/
200Success

No content

get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this risk module.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
poolstring · uriRequired
premiums_accountstring · uriRequired
jr_etkstring · uriRead-onlyOptional
sr_etkstring · uriRead-onlyOptional
descriptionstringOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/riskmodules/{address}/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this risk module.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
poolstring · uriRequired
premiums_accountstring · uriRequired
jr_etkstring · uriRead-onlyOptional
sr_etkstring · uriRead-onlyOptional
descriptionstringOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/riskmodules/{address}/active_policies/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this risk module.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
poolstring · uriRequired
premiums_accountstring · uriRequired
jr_etkstring · uriRead-onlyOptional
sr_etkstring · uriRead-onlyOptional
descriptionstringOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/riskmodules/{address}/active_premiums/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this risk module.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
poolstring · uriRequired
premiums_accountstring · uriRequired
jr_etkstring · uriRead-onlyOptional
sr_etkstring · uriRead-onlyOptional
descriptionstringOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/riskmodules/{address}/cashflow/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this risk module.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
poolstring · uriRequired
premiums_accountstring · uriRequired
jr_etkstring · uriRead-onlyOptional
sr_etkstring · uriRead-onlyOptional
descriptionstringOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/riskmodules/{address}/gwp/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this risk module.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
poolstring · uriRequired
premiums_accountstring · uriRequired
jr_etkstring · uriRead-onlyOptional
sr_etkstring · uriRead-onlyOptional
descriptionstringOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/riskmodules/{address}/gwp_history/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this risk module.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
poolstring · uriRequired
premiums_accountstring · uriRequired
jr_etkstring · uriRead-onlyOptional
sr_etkstring · uriRead-onlyOptional
descriptionstringOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/riskmodules/{address}/matured_surplus/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this risk module.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
poolstring · uriRequired
premiums_accountstring · uriRequired
jr_etkstring · uriRead-onlyOptional
sr_etkstring · uriRead-onlyOptional
descriptionstringOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/riskmodules/{address}/matured_surplus_history/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this risk module.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
poolstring · uriRequired
premiums_accountstring · uriRequired
jr_etkstring · uriRead-onlyOptional
sr_etkstring · uriRead-onlyOptional
descriptionstringOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/riskmodules/{address}/scr/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this risk module.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
poolstring · uriRequired
premiums_accountstring · uriRequired
jr_etkstring · uriRead-onlyOptional
sr_etkstring · uriRead-onlyOptional
descriptionstringOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/riskmodules/{address}/scr_history/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this risk module.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
poolstring · uriRequired
premiums_accountstring · uriRequired
jr_etkstring · uriRead-onlyOptional
sr_etkstring · uriRead-onlyOptional
descriptionstringOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/riskmodules/{address}/surplus/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this risk module.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
poolstring · uriRequired
premiums_accountstring · uriRequired
jr_etkstring · uriRead-onlyOptional
sr_etkstring · uriRead-onlyOptional
descriptionstringOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/riskmodules/{address}/surplus_history/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
addressstringRequired

A unique value identifying this risk module.

Responses
chevron-right
200Success
application/json
urlstring · uriRead-onlyOptional
addressstringRequired
namestring · min: 1 · max: 40Required
poolstring · uriRequired
premiums_accountstring · uriRequired
jr_etkstring · uriRead-onlyOptional
sr_etkstring · uriRead-onlyOptional
descriptionstringOptional
logostring · uriRead-onlyOptional
linksstringRead-onlyOptional
custom_dataobject · CustomdataOptional
get
/riskmodules/{address}/wonpremiumsinout/
200Success

Last updated