Stake | Narval

Narval | Docs

Github Home

List unstakeable positions

get

Returns a list of positions that can be unstaked.

Authorizations

Query parameters

networkIdstringoptional

The network ID to list unstakeable positions for

accountIdstringoptional

The account ID to list unstakeable positions for

Header parameters

x-client-idstringrequired

x-connection-idstringrequired

The provider connection through which the resource is accessed

Authorizationstringoptional

Responses

application/json

get

curl -L \
  --url 'https://auth.armory.narval.xyz/v1/provider/unstakes/list-unstakeable-positions' \
  --header 'detached-jws: YOUR_API_KEY' \
  --header 'x-client-id: text' \
  --header 'x-connection-id: text'

200

400

401

403

404

409

422

500

502

{
  "data": [
    {
      "positionId": "text",
      "status": "opening",
      "provider": "text",
      "externalStatus": "text",
      "networkId": "text",
      "accountId": "text",
      "clientId": "text",
      "connectionId": "text"
    }
  ]
}

The unstakeable positions were successfully retrieved.

Get unstake by ID

get

Returns a specific unstake request by ID.

Authorizations

Path parameters

unstakeIdstringrequired

The unstake ID to retrieve

Header parameters

x-client-idstringrequired

x-connection-idstringrequired

The provider connection through which the resource is accessed

Authorizationstringoptional

Responses

application/json

get

curl -L \
  --url 'https://auth.armory.narval.xyz/v1/provider/unstakes/{unstakeId}' \
  --header 'detached-jws: YOUR_API_KEY' \
  --header 'x-client-id: text' \
  --header 'x-connection-id: text'

200

400

401

403

404

409

422

500

502

{
  "data": {
    "unstakeRequest": {
      "unstakeId": "text",
      "provider": "anchorage",
      "createdAt": null,
      "networkId": "text",
      "externalId": "text",
      "accountId": "text",
      "clientId": "text",
      "connectionId": "text",
      "status": "pending_approval",
      "externalStatus": "text"
    },
    "transactions": [
      {
        "externalTxId": "text",
        "externalTransactionStatus": "text"
      }
    ]
  }
}

The unstake request was successfully retrieved.

Get stake by ID

get

Returns a specific stake request by ID.

Authorizations

Path parameters

stakeIdstringrequired

Header parameters

x-client-idstringrequired

x-connection-idstringrequired

The provider connection through which the resource is accessed

Authorizationstringoptional

Responses

application/json

get

curl -L \
  --url 'https://auth.armory.narval.xyz/v1/provider/stakes/{stakeId}' \
  --header 'detached-jws: YOUR_API_KEY' \
  --header 'x-client-id: text' \
  --header 'x-connection-id: text'

200

400

401

403

404

409

422

500

502

{
  "data": {
    "stakeRequest": {
      "stakeRequestId": "text",
      "provider": "anchorage",
      "createdAt": null,
      "networkId": "text",
      "externalId": "text",
      "accountId": "text",
      "clientId": "text",
      "connectionId": "text",
      "status": "pending_approval",
      "externalStatus": "text"
    },
    "positions": [
      {
        "positionId": "text",
        "status": "opening",
        "provider": "text",
        "externalStatus": "text",
        "networkId": "text",
        "accountId": "text",
        "clientId": "text",
        "connectionId": "text"
      }
    ],
    "transactions": [
      {
        "externalTxId": "text",
        "externalTransactionStatus": "text"
      }
    ]
  }
}

The stake request was successfully retrieved.

Create stake

post

Creates a new stake request on the provider.

Authorizations

Header parameters

x-client-idstringrequired

x-connection-idstringrequired

The provider connection through which the resource is accessed

Authorizationstringoptional

Body

Request to stake tokens on an account. Will result in one or multiple stake positions.

sourceobjectrequired

createdAtanyoptional

validatorobjectrequired

amountstringrequired

idempotenceIdstringrequired

stakeRequestIdstringoptional

Sets the stake ID to an arbitrary value.

memostringoptional

Responses

application/json

post

curl -L \
  --request POST \
  --url 'https://auth.armory.narval.xyz/v1/provider/stakes' \
  --header 'detached-jws: YOUR_API_KEY' \
  --header 'x-client-id: text' \
  --header 'x-connection-id: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "source": {
      "type": "account",
      "id": "text"
    },
    "createdAt": null,
    "validator": {
      "address": "text"
    },
    "amount": "text",
    "idempotenceId": "text",
    "stakeRequestId": "text",
    "memo": "text"
  }'

201

400

401

403

404

409

422

500

502

{
  "data": {
    "stakeRequest": {
      "stakeRequestId": "text",
      "provider": "anchorage",
      "createdAt": null,
      "networkId": "text",
      "externalId": "text",
      "accountId": "text",
      "clientId": "text",
      "connectionId": "text",
      "status": "pending_approval",
      "externalStatus": "text"
    },
    "positions": [
      {
        "positionId": "text",
        "status": "opening",
        "provider": "text",
        "externalStatus": "text",
        "networkId": "text",
        "accountId": "text",
        "clientId": "text",
        "connectionId": "text"
      }
    ],
    "transactions": [
      {
        "externalTxId": "text",
        "externalTransactionStatus": "text"
      }
    ]
  }
}

The stake request was successfully created.

Create unstake

post

Creates a new unstake request on the provider.

Authorizations

Header parameters

x-client-idstringrequired

x-connection-idstringrequired

The provider connection through which the resource is accessed

Authorizationstringoptional

Body

Request to unstake from a specific stake position.

amountstringrequired

idempotenceIdstringrequired

stakePositionIdstringrequired

sourceobjectrequired

unstakeIdstringoptional

Sets the unstake ID to an arbitrary value.

Responses

application/json

post

curl -L \
  --request POST \
  --url 'https://auth.armory.narval.xyz/v1/provider/unstakes' \
  --header 'detached-jws: YOUR_API_KEY' \
  --header 'x-client-id: text' \
  --header 'x-connection-id: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": "text",
    "idempotenceId": "text",
    "stakePositionId": "text",
    "source": {
      "type": "account",
      "id": "text"
    },
    "unstakeId": "text"
  }'

201

400

401

403

404

409

422

500

502

{
  "data": {
    "unstakeRequest": {
      "unstakeId": "text",
      "provider": "anchorage",
      "createdAt": null,
      "networkId": "text",
      "externalId": "text",
      "accountId": "text",
      "clientId": "text",
      "connectionId": "text",
      "status": "pending_approval",
      "externalStatus": "text"
    },
    "transactions": [
      {
        "externalTxId": "text",
        "externalTransactionStatus": "text"
      }
    ]
  }
}

The unstake request was successfully created.

List unstakeable positions

Get unstake by ID

Get stake by ID

Create stake

Show child attributes

Show child attributes

Create unstake

Show child attributes