Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Hevn Inc

Hevn Inc Balance API

The Balance API from Hevn Inc — 20 operation(s) for balance.

Documentation Provider Profile APIs.io OpenAPI GitHub

Hevn Inc Balance API is one of 31 APIs that Hevn Inc publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Balance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 20 operations across 20 paths, and defines 18 schemas. It is described by OpenAPI 3.1.0, at version 0.1.2.

Requests are made against a single base URL, https://api.hevn.finance.

20 operations 20 paths 18 schemas 6 GET14 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.2
Base URL
https://api.hevn.finance/api/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Hevn Inc Balance API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer). An API key is passed in the header as x-api-key (ApiKeyAuth).

  • ApiKeyAuth — Alternative HEVN API key header. The CLI defaults to Authorization Bearer unless configured with HEVNAPIKEYHEADER=X-Api-Key.

Paths & Operations 20

Across 20 paths, the API surfaces 20 operations — 6 GET, 14 POST. Each is listed below with its method, path, parameters, and response codes.

Balance 20
GET
/api/v1/balance
Get wallet balances
get_balances_api_v1_balance_get 2 params → 200422
POST
/api/v1/balance/withdraw_onchain
Withdraw to onchain address
withdraw_onchain_api_v1_balance_withdraw_onchain_post 1 param body → 200422
POST
/api/v1/balance/sweep
Sweep custodial balance
sweep_custodial_api_v1_balance_sweep_post 1 param → 200422
GET
/api/v1/balance/transaction/status/{quote_id}
Get transaction status
get_transaction_status_api_v1_balance_transaction_status__quote_id__get 2 params → 200422
GET
/api/v1/balance/oneclick/tokens
Get supported tokens for cross-chain swaps
get_oneclick_tokens_api_v1_balance_oneclick_tokens_get → 200
POST
/api/v1/balance/payin/quote
Get cross-chain payin quote
create_payin_quote_api_v1_balance_payin_quote_post 1 param body → 200422
POST
/api/v1/balance/payin/submit
Submit cross-chain payin
submit_payin_api_v1_balance_payin_submit_post 1 param body → 204422
POST
/api/v1/balance/payout/quote
Get payout quote
get_payout_quote_api_v1_balance_payout_quote_post 1 param body → 200422
POST
/api/v1/balance/payout/quote/dry_run
Estimate payout quote
dry_run_payout_quote_api_v1_balance_payout_quote_dry_run_post 1 param body → 200422
POST
/api/v1/balance/payout/quote/submit
Activate payout quote
submit_payout_quote_api_v1_balance_payout_quote_submit_post 1 param body → 200422
GET
/api/v1/wallet/balance
Get wallet balances
get_balances_package_alias_api_v1_wallet_balance_get 2 params → 200422
POST
/api/v1/wallet/balance/withdraw_onchain
Withdraw to onchain address
withdraw_onchain_package_alias_api_v1_wallet_balance_withdraw_onchain_post 1 param body → 200422
POST
/api/v1/wallet/balance/sweep
Sweep custodial balance
sweep_custodial_package_alias_api_v1_wallet_balance_sweep_post 1 param → 200422
GET
/api/v1/wallet/balance/transaction/status/{quote_id}
Get transaction status
get_transaction_status_package_alias_api_v1_wallet_balance_transaction_status__quote_id__get 2 params → 200422
GET
/api/v1/wallet/balance/oneclick/tokens
Get supported tokens for cross-chain swaps
get_oneclick_tokens_package_alias_api_v1_wallet_balance_oneclick_tokens_get → 200
POST
/api/v1/wallet/balance/payin/quote
Get cross-chain payin quote
create_payin_quote_package_alias_api_v1_wallet_balance_payin_quote_post 1 param body → 200422
POST
/api/v1/wallet/balance/payin/submit
Submit cross-chain payin
submit_payin_package_alias_api_v1_wallet_balance_payin_submit_post 1 param body → 204422
POST
/api/v1/wallet/balance/payout/quote
Get payout quote
get_payout_quote_package_alias_api_v1_wallet_balance_payout_quote_post 1 param body → 200422
POST
/api/v1/wallet/balance/payout/quote/dry_run
Estimate payout quote
dry_run_payout_quote_package_alias_api_v1_wallet_balance_payout_quote_dry_run_post 1 param body → 200422
POST
/api/v1/wallet/balance/payout/quote/submit
Activate payout quote
submit_payout_quote_package_alias_api_v1_wallet_balance_payout_quote_submit_post 1 param body → 200422

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are UniversalQuoteResponse (18 properties), UniversalTransactionResponse (15 properties), AccountBalancesResponse (7 properties), PayoutStatusResponse (7 properties). Each schema is shown below with its type and property counts.

PayoutQuoteRequest
object
Request for payout quote to contact.
3 properties 2 required
PayoutQuoteDryRunResponse
object
Approximate payout quote response without provider-side activation.
4 properties 2 required
AccountBalancesResponse
object
7 properties 6 required
PayoutStatusResponse
object
Response with payout status.
7 properties 6 required
UniversalQuoteResponse
object
Universal quote response.
18 properties 6 required
WithdrawOnchainRequest
object
Request to withdraw from Swipelux wallet to onchain address.
2 properties 1 required
ValidationError
object
3 properties 3 required
WalletType
string
SubmitPayoutQuoteRequest
object
Request to activate a payout quote.
6 properties 1 required
SubmitPayoutQuoteResponse
object
Response after activating a payout quote.
5 properties 3 required
SwapType
string
Type of swap quote.
PayinSubmitRequest
object
Request to materialize a 1click PAYIN by deposit address.
1 property 1 required
HTTPValidationError
object
1 property
PayoutQuoteDryRunRequest
object
Request for approximate payout quote without contact.
5 properties 1 required
OneClickChain
string
1click chain codes.
BalancesResponse
object
Response with wallet balances.
3 properties 1 required
UniversalTransactionResponse
object
Universal transaction response.
15 properties 9 required
PayinQuoteRequest
object
Request for cross-chain payin quote.
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hevn-inc-balance-api-openapi.yml Raw ↑

Other APIs Hevn Inc publishes across the network.

Hevn Inc 2FA API
AE Profile APIs.io
Hevn Inc Activity API
AE Profile APIs.io
Hevn Inc apps API
AE Profile APIs.io
Hevn Inc apps-transfer API
AE Profile APIs.io
Hevn Inc auth API
AE Profile APIs.io
Hevn Inc B2B API
AE Profile APIs.io
Hevn Inc Banks API
AE Profile APIs.io
Hevn Inc Cards API
AE Profile APIs.io
Hevn Inc Chat API
AE Profile APIs.io
Hevn Inc contracts API
AE Profile APIs.io
Hevn Inc Devices API
AE Profile APIs.io
Hevn Inc documents API
AE Profile APIs.io
#Balance
← Back to H APIs
API Details
ID
hevn-inc:hevn-inc-balance-api
Base URL
https://api.hevn.finance/api/v1
Docs
https://hevninc.mintlify.app/
Provider
Hevn Inc
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network