/createTrigger - Aperture API for UniV3 Automation

Request

Body Params application/json

payloadSignature

string

required

Signature of the payload.

>= 1 characters

payload

object

required

ownerAddr

string

required

The owner address of the position; must be a checksum address.

>= 1 characters

chainId

enum<number>

required

The chain id of the network. Must be one of the chains supported by Aperture.

Allowed values:

1421615421613

Example:

1

nftId

string

required

The nonfungible token id of the position.

>= 1 characters

action

required

condition

required

The condition which triggers the action. If a trigger is successfully created with a condition that is already met at the time of trigger creation, then the action is immediately eligible to be triggered.

expiration

integer

required

Unix timestamp in seconds when this trigger expires.

> 0

permitInfo

object

optional

If Aperture doesn't already have authority over the position, then permitInfo should be obtained from the user and populated here.

signature

string

required

A raw signature of the ERC-712 typed message described in ERC-4494; the signature can be generated, for example, by https://docs.ethers.org/v5/api/signer/#Signer-signTypedData.

>= 1 characters

deadline

string

required

Unix timestamp in seconds indicating deadline for the signed "permit".

>= 1 characters

Example

{
    "payloadSignature": "string",
    "payload": {
        "ownerAddr": "string",
        "chainId": 1,
        "nftId": "string",
        "action": {
            "type": "Close",
            "slippage": 0,
            "maxGasProportion": 1
        },
        "condition": {
            "type": "Time",
            "timeAfterEpochSec": 1
        },
        "expiration": 1
    },
    "permitInfo": {
        "signature": "string",
        "deadline": "string"
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.aperture.finance/createTrigger' \
--header 'Content-Type: application/json' \
--data-raw '{
    "payloadSignature": "string",
    "payload": {
        "ownerAddr": "string",
        "chainId": 1,
        "nftId": "string",
        "action": {
            "type": "Close",
            "slippage": 0,
            "maxGasProportion": 1
        },
        "condition": {
            "type": "Time",
            "timeAfterEpochSec": 1
        },
        "expiration": 1
    },
    "permitInfo": {
        "signature": "string",
        "deadline": "string"
    }
}'

Responses

🟢200Trigger created successfully.

application/json

Body

object {0}

Example

{}

🟠400Bad Request

🔴500Internal Server Error