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

# Intents

Intent lifecycle

## GET /intents

> List intents

```json
{"openapi":"3.0.3","info":{"title":"Mimic Protocol API","version":"1.0.1"},"tags":[{"name":"Intents","description":"Intent lifecycle"}],"servers":[{"url":"https://api-protocol.mimic.fi"}],"paths":{"/intents":{"get":{"summary":"List intents","operationId":"getIntents","tags":["Intents"],"parameters":[{"name":"user","in":"query","description":"Filter by user address","schema":{"$ref":"#/components/schemas/Address"}},{"name":"deadlineAfter","in":"query","description":"Filter intents with deadline > this value (Unix epoch seconds)","schema":{"$ref":"#/components/schemas/BigInteger"}},{"name":"deadlineBefore","in":"query","description":"Filter intents with deadline ≤ this value (Unix epoch seconds)","schema":{"$ref":"#/components/schemas/BigInteger"}},{"name":"settler","in":"query","description":"Filter by settler address","schema":{"$ref":"#/components/schemas/Address"}},{"$ref":"#/components/parameters/OffsetParam"},{"$ref":"#/components/parameters/LimitParam"}],"responses":{"200":{"description":"List of intents","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AxiaIntent"}}}}}}}}},"components":{"schemas":{"Address":{"type":"string","description":"A valid EVM (0x-prefixed hex) address."},"BigInteger":{"type":"string","description":"A non-negative integer represented as a decimal string."},"AxiaIntent":{"description":"An intent enriched with lifecycle state, proposals, and logs","allOf":[{"$ref":"#/components/schemas/Intent"},{"type":"object","required":["hash","executionHash","status","proposals","logs"],"properties":{"hash":{"$ref":"#/components/schemas/HexString"},"executionHash":{"$ref":"#/components/schemas/HexString"},"status":{"type":"string","enum":["created","enqueued","discarded","submitted","succeeded","failed","expired"]},"proposals":{"type":"array","items":{"$ref":"#/components/schemas/Proposal"}},"logs":{"type":"array","items":{"$ref":"#/components/schemas/IntentLog"}}}}]},"Intent":{"type":"object","required":["op","user","settler","nonce","deadline","data","maxFees","events","configSig","minValidations"],"properties":{"op":{"$ref":"#/components/schemas/OpType"},"user":{"$ref":"#/components/schemas/Address"},"settler":{"allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Address of the settler contract that will settle this intent"},"nonce":{"$ref":"#/components/schemas/HexString"},"deadline":{"allOf":[{"$ref":"#/components/schemas/BigInteger"}],"description":"Unix epoch in seconds after which the intent expires"},"data":{"allOf":[{"$ref":"#/components/schemas/HexString"}],"description":"ABI-encoded operation-specific data"},"maxFees":{"type":"array","items":{"$ref":"#/components/schemas/MaxFee"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/IntentEvent"}},"configSig":{"$ref":"#/components/schemas/Signature"},"minValidations":{"type":"number","minimum":0}}},"OpType":{"type":"integer","enum":[0,1,2,3],"description":"Intent operation type:\n- `0` — Swap\n- `1` — Transfer\n- `2` — EvmCall\n- `3` — SvmCall\n"},"HexString":{"type":"string","description":"An arbitrary 0x-prefixed hex string."},"MaxFee":{"type":"object","required":["token","amount"],"properties":{"token":{"$ref":"#/components/schemas/Address"},"amount":{"$ref":"#/components/schemas/BigInteger"}}},"IntentEvent":{"type":"object","required":["topic","data"],"properties":{"topic":{"$ref":"#/components/schemas/HexString"},"data":{"$ref":"#/components/schemas/HexString"}}},"Signature":{"type":"string","description":"A 65-byte hex-encoded ECDSA signature (130 hex chars + 0x prefix)."},"Proposal":{"type":"object","required":["solver","data","deadline","fees","feeUsd","status","signatures"],"properties":{"solver":{"$ref":"#/components/schemas/Address"},"data":{"$ref":"#/components/schemas/HexString"},"deadline":{"$ref":"#/components/schemas/BigInteger"},"fees":{"type":"array","items":{"$ref":"#/components/schemas/BigInteger"}},"feeUsd":{"allOf":[{"$ref":"#/components/schemas/BigInteger"}],"description":"Total fee expressed in USD (scaled integer)"},"status":{"type":"string","enum":["received","discarded","submitted","succeeded","failed","expired"]},"description":{"type":"string"},"signatures":{"type":"array","items":{"$ref":"#/components/schemas/Signature"}},"transactionHash":{"$ref":"#/components/schemas/HexString"},"destTransactionHash":{"$ref":"#/components/schemas/HexString"}}},"IntentLog":{"type":"object","required":["level","data","createdAt"],"properties":{"level":{"type":"string","enum":["info","success","error"]},"data":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}}},"parameters":{"OffsetParam":{"name":"offset","in":"query","schema":{"type":"integer","minimum":0,"default":0}},"LimitParam":{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":10}}}}}
```

## GET /intents/{hash}

> Get an intent by hash

```json
{"openapi":"3.0.3","info":{"title":"Mimic Protocol API","version":"1.0.1"},"tags":[{"name":"Intents","description":"Intent lifecycle"}],"servers":[{"url":"https://api-protocol.mimic.fi"}],"paths":{"/intents/{hash}":{"get":{"summary":"Get an intent by hash","operationId":"getIntent","tags":["Intents"],"parameters":[{"name":"hash","in":"path","required":true,"schema":{"$ref":"#/components/schemas/HexString"}}],"responses":{"200":{"description":"Intent details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AxiaIntent"}}}},"404":{"$ref":"#/components/responses/NotFound"}}}}},"components":{"schemas":{"HexString":{"type":"string","description":"An arbitrary 0x-prefixed hex string."},"AxiaIntent":{"description":"An intent enriched with lifecycle state, proposals, and logs","allOf":[{"$ref":"#/components/schemas/Intent"},{"type":"object","required":["hash","executionHash","status","proposals","logs"],"properties":{"hash":{"$ref":"#/components/schemas/HexString"},"executionHash":{"$ref":"#/components/schemas/HexString"},"status":{"type":"string","enum":["created","enqueued","discarded","submitted","succeeded","failed","expired"]},"proposals":{"type":"array","items":{"$ref":"#/components/schemas/Proposal"}},"logs":{"type":"array","items":{"$ref":"#/components/schemas/IntentLog"}}}}]},"Intent":{"type":"object","required":["op","user","settler","nonce","deadline","data","maxFees","events","configSig","minValidations"],"properties":{"op":{"$ref":"#/components/schemas/OpType"},"user":{"$ref":"#/components/schemas/Address"},"settler":{"allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Address of the settler contract that will settle this intent"},"nonce":{"$ref":"#/components/schemas/HexString"},"deadline":{"allOf":[{"$ref":"#/components/schemas/BigInteger"}],"description":"Unix epoch in seconds after which the intent expires"},"data":{"allOf":[{"$ref":"#/components/schemas/HexString"}],"description":"ABI-encoded operation-specific data"},"maxFees":{"type":"array","items":{"$ref":"#/components/schemas/MaxFee"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/IntentEvent"}},"configSig":{"$ref":"#/components/schemas/Signature"},"minValidations":{"type":"number","minimum":0}}},"OpType":{"type":"integer","enum":[0,1,2,3],"description":"Intent operation type:\n- `0` — Swap\n- `1` — Transfer\n- `2` — EvmCall\n- `3` — SvmCall\n"},"Address":{"type":"string","description":"A valid EVM (0x-prefixed hex) address."},"BigInteger":{"type":"string","description":"A non-negative integer represented as a decimal string."},"MaxFee":{"type":"object","required":["token","amount"],"properties":{"token":{"$ref":"#/components/schemas/Address"},"amount":{"$ref":"#/components/schemas/BigInteger"}}},"IntentEvent":{"type":"object","required":["topic","data"],"properties":{"topic":{"$ref":"#/components/schemas/HexString"},"data":{"$ref":"#/components/schemas/HexString"}}},"Signature":{"type":"string","description":"A 65-byte hex-encoded ECDSA signature (130 hex chars + 0x prefix)."},"Proposal":{"type":"object","required":["solver","data","deadline","fees","feeUsd","status","signatures"],"properties":{"solver":{"$ref":"#/components/schemas/Address"},"data":{"$ref":"#/components/schemas/HexString"},"deadline":{"$ref":"#/components/schemas/BigInteger"},"fees":{"type":"array","items":{"$ref":"#/components/schemas/BigInteger"}},"feeUsd":{"allOf":[{"$ref":"#/components/schemas/BigInteger"}],"description":"Total fee expressed in USD (scaled integer)"},"status":{"type":"string","enum":["received","discarded","submitted","succeeded","failed","expired"]},"description":{"type":"string"},"signatures":{"type":"array","items":{"$ref":"#/components/schemas/Signature"}},"transactionHash":{"$ref":"#/components/schemas/HexString"},"destTransactionHash":{"$ref":"#/components/schemas/HexString"}}},"IntentLog":{"type":"object","required":["level","data","createdAt"],"properties":{"level":{"type":"string","enum":["info","success","error"]},"data":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}},"Error":{"type":"object","properties":{"message":{"type":"string"}}}},"responses":{"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}
```