> For the complete documentation index, see [llms.txt](https://docs.skylinebridge.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.skylinebridge.tech/cardano-api/models.md).

# Models

## The BridgingTxFeeResponse object

```json
{"openapi":"3.1.1","info":{"title":"Cardano API","version":"1.0"},"components":{"schemas":{"BridgingTxFeeResponse":{"properties":{"bridgingFee":{"description":"Bridging fee for covering submission on the destination chain, expressed in Lovelace","type":"integer"},"fee":{"description":"Transaction fee on the source chain, expressed in Lovelace","type":"integer"}},"type":"object"}}}}
```

## The BridgingTxResponse object

```json
{"openapi":"3.1.1","info":{"title":"Cardano API","version":"1.0"},"components":{"schemas":{"BridgingTxResponse":{"properties":{"amount":{"description":"Amount of currency to be bridged, expressed in Lovelace","type":"integer"},"bridgingFee":{"description":"Bridging fee for covering submission on the destination chain, expressed in Lovelace","type":"integer"},"nativeTokenAmount":{"description":"Amount of native token to be bridged","type":"integer"},"txHash":{"description":"Transaction hash","type":"string"},"txRaw":{"description":"Raw transaction data, encoded as a hexadecimal string","type":"string"}},"type":"object"}}}}
```

## The CreateBridgingTxRequest object

```json
{"openapi":"3.1.1","info":{"title":"Cardano API","version":"1.0"},"components":{"schemas":{"CreateBridgingTxRequest":{"properties":{"bridgingFee":{"description":"Fee covering the submission of the transaction on the destination chain, expressed in Lovelace","type":"integer"},"destinationChainId":{"description":"Destination chain ID","type":"string"},"operationFee":{"description":"Fee covering the operational cost of processing the bridging request, expressed in Lovelace","type":"integer"},"senderAddr":{"description":"Address that initiates the bridging request on the source chain","type":"string"},"skipUtxos":{"description":"Specifies the UTXO to skip during transaction creation on the source chain","items":{"$ref":"#/components/schemas/UtxoRequest"},"type":"array"},"sourceChainId":{"description":"Source chain ID","type":"string"},"transactions":{"description":"Array of transactions requested by the sender","items":{"$ref":"#/components/schemas/CreateBridgingTxTransactionRequest"},"type":"array"},"useFallback":{"description":"Indicates if fallback mechanism should be used","type":"boolean"},"utxoCacheKey":{"description":"Key used to enable caching of spent UTXOs","type":"string"}},"required":["destinationChainId","senderAddr","sourceChainId","transactions"],"type":"object"},"UtxoRequest":{"properties":{"hash":{"description":"Transaction hash","type":"string"},"index":{"description":"Output index of UTXO","type":"integer"}},"type":"object"},"CreateBridgingTxTransactionRequest":{"properties":{"addr":{"description":"Receiver address","type":"string"},"amount":{"description":"Amount to be bridged","type":"integer"},"isNativeToken":{"description":"True if the amount is specified in a native token; false if in a currency on source chain","type":"boolean"}},"required":["addr","amount"],"type":"object"}}}}
```

## The CreateBridgingTxTransactionRequest object

```json
{"openapi":"3.1.1","info":{"title":"Cardano API","version":"1.0"},"components":{"schemas":{"CreateBridgingTxTransactionRequest":{"properties":{"addr":{"description":"Receiver address","type":"string"},"amount":{"description":"Amount to be bridged","type":"integer"},"isNativeToken":{"description":"True if the amount is specified in a native token; false if in a currency on source chain","type":"boolean"}},"required":["addr","amount"],"type":"object"}}}}
```

## The ErrorResponse object

```json
{"openapi":"3.1.1","info":{"title":"Cardano API","version":"1.0"},"components":{"schemas":{"ErrorResponse":{"properties":{"err":{"type":"string"}},"type":"object"}}}}
```

## The SettingsResponse object

```json
{"openapi":"3.1.1","info":{"title":"Cardano API","version":"1.0"},"components":{"schemas":{"SettingsResponse":{"properties":{"bridgingSettings":{"allOf":[{"$ref":"#/components/schemas/BridgingSettings"}],"description":"Settings for bridge"},"cardanoChainsNativeTokens":{"additionalProperties":{"items":{"$ref":"#/components/schemas/sendtx.TokenExchangeConfig"},"type":"array"},"description":"For each source chain, defines the native token that will be received on the destination chain","type":"object"},"enabledChains":{"description":"Participating chains in the bridge","items":{"type":"string"},"type":"array"},"runMode":{"allOf":[{"$ref":"#/components/schemas/VCRunMode"}],"description":"Specifies the current operating mode of the application"}},"type":"object"},"BridgingSettings":{"properties":{"maxAmountAllowedToBridge":{"description":"Maximum amount of currency allowed to be bridged","type":"string"},"maxReceiversPerBridgingRequest":{"description":"Maximum number of receivers allowed in a bridging request","type":"integer"},"maxTokenAmountAllowedToBridge":{"description":"Maximum amount of native tokens allowed to be bridged","type":"string"},"minChainFeeForBridging":{"additionalProperties":{"type":"integer"},"description":"For each chain, the minimum fee required to cover the submission of the transaction on the destination chain","type":"object"},"minOperationFee":{"additionalProperties":{"type":"integer"},"description":"For each chain, the minimum fee required to cover operational costs","type":"object"},"minUtxoChainValue":{"additionalProperties":{"type":"integer"},"description":"For each chain, the minimum allowed UTXO value","type":"object"},"minValueToBridge":{"description":"Minimum value allowed to be bridged","type":"integer"}},"type":"object"},"sendtx.TokenExchangeConfig":{"properties":{"dstChainID":{"description":"Destination chain ID","type":"string"},"tokenName":{"description":"Token identifier in the format \"policyId.name\"","type":"string"}},"type":"object"},"VCRunMode":{"enum":["reactor","skyline"],"type":"string"}}}}
```

## The UtxoRequest object

```json
{"openapi":"3.1.1","info":{"title":"Cardano API","version":"1.0"},"components":{"schemas":{"UtxoRequest":{"properties":{"hash":{"description":"Transaction hash","type":"string"},"index":{"description":"Output index of UTXO","type":"integer"}},"type":"object"}}}}
```

## The VCRunMode object

```json
{"openapi":"3.1.1","info":{"title":"Cardano API","version":"1.0"},"components":{"schemas":{"VCRunMode":{"enum":["reactor","skyline"],"type":"string"}}}}
```

## The BridgingSettings object

```json
{"openapi":"3.1.1","info":{"title":"Cardano API","version":"1.0"},"components":{"schemas":{"BridgingSettings":{"properties":{"maxAmountAllowedToBridge":{"description":"Maximum amount of currency allowed to be bridged","type":"string"},"maxReceiversPerBridgingRequest":{"description":"Maximum number of receivers allowed in a bridging request","type":"integer"},"maxTokenAmountAllowedToBridge":{"description":"Maximum amount of native tokens allowed to be bridged","type":"string"},"minChainFeeForBridging":{"additionalProperties":{"type":"integer"},"description":"For each chain, the minimum fee required to cover the submission of the transaction on the destination chain","type":"object"},"minOperationFee":{"additionalProperties":{"type":"integer"},"description":"For each chain, the minimum fee required to cover operational costs","type":"object"},"minUtxoChainValue":{"additionalProperties":{"type":"integer"},"description":"For each chain, the minimum allowed UTXO value","type":"object"},"minValueToBridge":{"description":"Minimum value allowed to be bridged","type":"integer"}},"type":"object"}}}}
```