Returns a list of all the sell orders executed by the user

GET /sell-orders

Returns a list of all the orders executed by the user

Query parameters

  • start string Required

    The start date of the dataset. This is inclusive of orders created at this exact date should be included.

  • end string Required

    The end date of the dataset. This is inclusive of orders created at this exact date should be included.

  • skip integer Required

    The number of orders to skip in dataset.

  • limit integer Required

    The number of orders to return in dataset.

Responses

  • 200 application/json

    Successful operation

    Hide response attributes Show response attributes object
    • id string
    • userId string

      An identifier that is the same for all orders of the same user. No personally identifiable information is required, the ID doesn't need to be a username or an email.

    • crypto object
      Hide crypto attributes Show crypto attributes object
      • id string
      • address string
      • network string
    • fiatAmountOutUsd string
    • fiat string

      The ISO 4217 code of the fiat currency used to pay for the order.

    • payment string

      The payment method used to buy the crypto. The ID defined in the configuration.

    • providerPayment string

      A provider-defined payment method, providing more details than the payment field. For example, if a VISA credit card was used with with the "debit-credit-card" payment method, this field may contain "VISA".

    • cryptoAmountIn string

      The amount of crypto sent or to be sent by the user.

    • fiatAmountOut string

      The amount of fiat actually sent to the user fiat account.

    • exchangeRate string

      The exchange rate used to get the amount of fiat

    • processingFees array[object]
      Hide processingFees attributes Show processingFees attributes object
      • label string
      • fiatAmount: string

        Amount of the fee taken, as an amount of the order fiat currency

    • partnerFees array[object]
      Hide partnerFees attributes Show partnerFees attributes object
      • label string
      • fiatAmount: string

        Amount of the fee taken, as an amount of the order fiat currency

    • createdAt string
    • updatedAt string
    • transactionHash string

      The hash of the transaction transfering the crypto to Stably Ramp wallet. This transaction is initiated by the user.

    • walletAddress string

      The wallet address of the user, used to send crypto to Stably Ramp.

    • providerWalletAddress string

      The wallet address of Stably Ramp, where the crypto must be sent.

    • status string

      The status of the order. Pending orders are periodically polled by StablyRamp. Completed, failed or cancelled orders are never polled again once StablyRamp detects one of these statuses

      Values are INITIATED, PENDING, COMPLETED, FAILED, or CANCELLED.

    • statusCode string

      If applicable, a code defined by Stably Ramp, providing more details than the StablyRamp-defined status field.

    • statusReason string

      If applicable, information explaining how the order has its current status.

    • partnerAccountId string

      An value identifying Consensys/StablyRamp as the partner associated with the transaction

  • 400 application/json

    An unexpected error

    Hide response attributes Show response attributes object
    • error string

      A description of the unexpected error.

    • code integer

      The error code associated with the unexpected error.

    • message string

      A detailed error message explaining the issue.

  • 500 application/json

    An unexpected error

    Hide response attributes Show response attributes object
    • error string

      A description of the unexpected error.

    • code integer

      The error code associated with the unexpected error.

    • message string

      A detailed error message explaining the issue.

GET /sell-orders
curl \
 -X GET https://ramp-api.dev.stably.io/public/api/v1/sell-orders?start=string&end=string&skip=42&limit=42
Response examples (200)
[
  {
    "id": "cd7ad58d",
    "userId": "user-52324447448",
    "link": "https://www.crypto-provider-example.com/order/cd7ad58d-0fbb-4ed5-9fdd-832c1709ce85",
    "crypto": {
      "id": "eth",
      "address": "0x000000000",
      "network": "ethereum"
    },
    "fiatAmountOutUsd": "100",
    "fiat": "USD",
    "payment": "debit-credit-card",
    "providerPayment": "Visa",
    "cryptoAmountIn": "0.0001",
    "fiatAmountOut": "100",
    "exchangeRate": "0.0001",
    "processingFees": [
      {
        "label": "fee label",
        "fiatAmount:": "10"
      }
    ],
    "partnerFees": [
      {
        "label": "fee label",
        "fiatAmount:": "10"
      }
    ],
    "createdAt": "2021-01-01T00:00:00Z",
    "updatedAt": "2021-01-01T00:00:00Z",
    "transactionHash": "0x000000000",
    "walletAddress": "0x000000000",
    "providerWalletAddress": "0x000000000",
    "status": "PENDING",
    "statusCode": "PROVIDER-PENDING-ORDER",
    "statusReason": "The order is currently being processed.",
    "partnerAccountId": "StablyRamp"
  }
]
Response examples (400)
{
  "error": "string",
  "code": 42,
  "message": "string"
}
Response examples (500)
{
  "error": "string",
  "code": 42,
  "message": "string"
}