# Lender's Vault Exposure Arkis provides APIs for lenders to monitor current positions across vaults and markets, as well as the risk exposure of their investments based on asset and venue distribution. The API allows lenders to analyze how capital is allocated across different protocols, assets, and networks, helping them better understand portfolio exposure and diversification. The endpoint below provides **asset exposure relative to the leveraged asset**. It supports flexible grouping of allocation using the `group_by` parameter, allowing results to be aggregated by **protocols, assets, networks**, or a combination of these dimensions. Depending on the selected grouping, some assets may not fall into a specific category. Such allocations are returned in a separate **`others`** section. The OpenAPI specification below describes the endpoints that are available for use with an API key.\ [This page](https://docs.arkis.xyz/home/for-developers/arkis-api/api-keys) includes step-by-step instructions on how to create and revoke an API key. The **Arkis Public API** is available at the following URL: .\ The API key must be included in the `Authorization` header in the format: `Bearer api_key`.
## Get a list of all vaults whitelisted for you organization > Get a list of basic information about all vaults whitelisted for your organization. ```json {"openapi":"3.1.1","info":{"title":"API","version":"1.0"},"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Bearer token authentication. Example: \"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\""}},"schemas":{"rest.Response-array_rest_VaultsExternalResponse":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/rest.VaultsExternalResponse"}}}},"rest.VaultsExternalResponse":{"type":"object","properties":{"address":{"type":"string"},"apy":{"type":"string"},"total_assets":{"$ref":"#/components/schemas/rest.TotalAssets"},"curator":{"type":"string"},"id":{"type":"integer"},"title":{"type":"string"},"underlying_asset":{"type":"string"}}},"rest.TotalAssets":{"type":"object","properties":{"amount":{"type":"string"},"symbol":{"type":"string"}}},"problemjson.ProblemDetails":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}}}}},"paths":{"https://api.arkis.xyz/e/v1/vaults":{"get":{"description":"Get a list of basic information about all vaults whitelisted for your organization.","tags":["vaults"],"summary":"Get a list of all vaults whitelisted for you organization","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rest.Response-array_rest_VaultsExternalResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemjson.ProblemDetails"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemjson.ProblemDetails"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemjson.ProblemDetails"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemjson.ProblemDetails"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemjson.ProblemDetails"}}}}}}}}} ``` ## Get detailed information about the specific vault > Get detailed information about a specific vault.\ > Optional group\_by query parameters can be used to modify how allocation data is grouped. ```json {"openapi":"3.1.1","info":{"title":"API","version":"1.0"},"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Bearer token authentication. Example: \"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\""}},"schemas":{"rest.Response-rest_VaultExternalResponse":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/rest.VaultExternalResponse"}}},"rest.VaultExternalResponse":{"type":"object","properties":{"address":{"type":"string"},"agreements":{"type":"array","items":{"$ref":"#/components/schemas/rest.Agreement"}},"apy":{"type":"string"},"total_assets":{"$ref":"#/components/schemas/rest.TotalAssets"},"curator":{"type":"string"},"exposure":{"type":"array","items":{"$ref":"#/components/schemas/rest.ExposureAsset"}},"groups":{"type":"array","items":{"$ref":"#/components/schemas/rest.AllocationGroup"}},"others":{"type":"array","items":{"$ref":"#/components/schemas/rest.ExposureAsset"}},"title":{"type":"string"},"underlying_asset":{"$ref":"#/components/schemas/rest.UnderlyingAsset"}}},"rest.Agreement":{"type":"object","properties":{"address":{"type":"string"},"apy":{"type":"string"},"id":{"type":"string"},"underlying_asset":{"$ref":"#/components/schemas/rest.UnderlyingAsset"}}},"rest.UnderlyingAsset":{"type":"object","properties":{"price_usdс":{"type":"string"},"symbol":{"type":"string"}}},"rest.TotalAssets":{"type":"object","properties":{"amount":{"type":"string"},"symbol":{"type":"string"}}},"rest.ExposureAsset":{"type":"object","properties":{"amount":{"type":"string","description":"Amount of asset in the position"},"oracle_price":{"type":"string"},"price_usdc":{"type":"string"},"symbol":{"type":"string"},"type":{"type":"string","enum":["spot","future"]}}},"rest.AllocationGroup":{"type":"object","properties":{"positions":{"type":"array","items":{"$ref":"#/components/schemas/rest.ExposureAsset"}},"network":{"type":"string"},"protocol":{"type":"string"}}},"problemjson.ProblemDetails":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}}}}},"paths":{"https://api.arkis.xyz/e/v1/vaults/{vault_id}":{"get":{"description":"Get detailed information about a specific vault.\nOptional group_by query parameters can be used to modify how allocation data is grouped.","tags":["vaults"],"summary":"Get detailed information about the specific vault","parameters":[{"schema":{"type":"string"},"description":"Vault ID","name":"vault_id","in":"path","required":true},{"schema":{"type":"array","items":{"enum":["protocol","network"],"type":"string"}},"style":"form","explode":true,"description":"Group allocations by defined criteria. The API supports grouping by one or more criteria (protocol, network).","name":"group_by","in":"query"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rest.Response-rest_VaultExternalResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemjson.ProblemDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemjson.ProblemDetails"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemjson.ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemjson.ProblemDetails"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemjson.ProblemDetails"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemjson.ProblemDetails"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/problemjson.ProblemDetails"}}}}}}}}} ```