Quotes

Quote a route for funding the intent from a source asset

Discovers, validates, scores and selects the best route from the given source asset to the intent’s destination requirement, and returns it as a quote. The destination comes from the funding intent; only the source is chosen here. By default (type EXACT_OUTPUT) the intent’s requirement is fixed and source.amount in the response is what the payer must send so that it arrives. With type EXACT_INPUT the request’s source.amount fixes what the payer sends and the response’s destination.amount is what the route delivers, which must cover the requirement; anything delivered above it is refunded to the payer. An optional Idempotency-Key replays the original result.

POST

funding-intents

{id}

quotes

Node.js SDK

import { Useroutr } from "@useroutr/sdk";

const useroutr = new Useroutr({ apiKey: process.env.USEROUTR_API_KEY });

const quote = await useroutr.quotes.create("fi_2d6a91c4", {
  source: { network: "stellar", asset: "asset_xlm_stellar" },
});

curl -X POST "https://api.sandbox.useroutr.com/v1/funding-intents/fi_2d6a91c4/quotes" \
  -H "Authorization: Bearer $USEROUTR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source":{"network":"stellar","asset":"asset_xlm_stellar"}}'

{
  "id": "<string>",
  "object": "quote",
  "funding_intent_id": "<string>",
  "application_id": "<string>",
  "type": "EXACT_INPUT",
  "status": "ACTIVE",
  "stellar_network": "testnet",
  "source": {
    "network": "<string>",
    "asset": "<string>",
    "amount": "<string>",
    "expected_amount": "<string>"
  },
  "destination": {
    "network": "<string>",
    "asset": "<string>",
    "address": "<string>",
    "amount": "<string>",
    "minimum_amount": "<string>"
  },
  "route": {
    "type": "DIRECT_STELLAR",
    "provider": "<string>",
    "steps": [
      {
        "type": "<string>",
        "provider": "<string>",
        "source_asset": "<string>",
        "destination_asset": "<string>"
      }
    ],
    "estimated_duration_seconds": 0,
    "confidence": 0,
    "price_impact_bps": 0,
    "score": "<string>"
  },
  "fees": {
    "items": [
      {
        "type": "NETWORK",
        "asset": "<string>",
        "amount": "<string>"
      }
    ],
    "total": "<string>"
  },
  "exchange_rate": "<string>",
  "slippage_bps": 0,
  "execution": {
    "id": "<string>",
    "object": "route_execution",
    "quote_id": "<string>",
    "funding_intent_id": "<string>",
    "provider": "<string>",
    "route_type": "DIRECT_STELLAR",
    "status": "PENDING",
    "phase": "CREATED",
    "provider_execution_id": "<string>",
    "transaction_hashes": [
      "<string>"
    ],
    "failure": {
      "code": "<string>",
      "message": "<string>"
    },
    "started_at": "<string>",
    "completed_at": "<string>"
  },
  "failure": {
    "code": "<string>",
    "message": "<string>"
  },
  "expires_at": "<string>",
  "lock_expires_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Application API authentication for developer backends: Authorization: Bearer ur_test_... or ur_live_.... Resolves the application, its environment and the key's status. Never a dashboard login.

Headers

idempotency-key

string

Required string length: 1 - 255

Path Parameters

string

required

Required string length: 1 - 64

Body

application/json

source

object

required

Show child attributes

type

enum<string>

Available options:

EXACT_INPUT,

EXACT_OUTPUT

slippage_bps

integer

Required range: 1 <= x <= 5000

Response

Default Response

string

required

object

enum<string>

required

Available options:

quote

funding_intent_id

string

required

application_id

string

required

type

enum<string>

required

Available options:

EXACT_INPUT,

EXACT_OUTPUT

status

enum<string>

required

Available options:

ACTIVE,

SELECTED,

LOCKED,

EXECUTING,

COMPLETED,

EXPIRED,

FAILED,

CANCELLED

stellar_network

enum<string>

required

Available options:

testnet,

mainnet,

local

source

object

required

Show child attributes

destination

object

required

Show child attributes

route

object

required

Show child attributes

fees

object

required

Show child attributes

exchange_rate

string

required

slippage_bps

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

execution

object | null

required

Show child attributes

failure

object | null

required

Show child attributes

expires_at

string

required

lock_expires_at

string | null

required

created_at

string

required

updated_at

string

required

Node.js SDK

import { Useroutr } from "@useroutr/sdk";

const useroutr = new Useroutr({ apiKey: process.env.USEROUTR_API_KEY });

const quote = await useroutr.quotes.create("fi_2d6a91c4", {
  source: { network: "stellar", asset: "asset_xlm_stellar" },
});

curl -X POST "https://api.sandbox.useroutr.com/v1/funding-intents/fi_2d6a91c4/quotes" \
  -H "Authorization: Bearer $USEROUTR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source":{"network":"stellar","asset":"asset_xlm_stellar"}}'

{
  "id": "<string>",
  "object": "quote",
  "funding_intent_id": "<string>",
  "application_id": "<string>",
  "type": "EXACT_INPUT",
  "status": "ACTIVE",
  "stellar_network": "testnet",
  "source": {
    "network": "<string>",
    "asset": "<string>",
    "amount": "<string>",
    "expected_amount": "<string>"
  },
  "destination": {
    "network": "<string>",
    "asset": "<string>",
    "address": "<string>",
    "amount": "<string>",
    "minimum_amount": "<string>"
  },
  "route": {
    "type": "DIRECT_STELLAR",
    "provider": "<string>",
    "steps": [
      {
        "type": "<string>",
        "provider": "<string>",
        "source_asset": "<string>",
        "destination_asset": "<string>"
      }
    ],
    "estimated_duration_seconds": 0,
    "confidence": 0,
    "price_impact_bps": 0,
    "score": "<string>"
  },
  "fees": {
    "items": [
      {
        "type": "NETWORK",
        "asset": "<string>",
        "amount": "<string>"
      }
    ],
    "total": "<string>"
  },
  "exchange_rate": "<string>",
  "slippage_bps": 0,
  "execution": {
    "id": "<string>",
    "object": "route_execution",
    "quote_id": "<string>",
    "funding_intent_id": "<string>",
    "provider": "<string>",
    "route_type": "DIRECT_STELLAR",
    "status": "PENDING",
    "phase": "CREATED",
    "provider_execution_id": "<string>",
    "transaction_hashes": [
      "<string>"
    ],
    "failure": {
      "code": "<string>",
      "message": "<string>"
    },
    "started_at": "<string>",
    "completed_at": "<string>"
  },
  "failure": {
    "code": "<string>",
    "message": "<string>"
  },
  "expires_at": "<string>",
  "lock_expires_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>",
    "requestId": "<string>",
    "retryable": true,
    "details": [
      {
        "path": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Overview

Endpoints

Quote a route for funding the intent from a source asset

Authorizations

Headers

Path Parameters

Body

Response