💸Step 7 - Dollar Cost Average

As you may already know, Dollar Cost Average (DCA) is the possibilité pour the User to program their investment.

For instance, they will be able to buy a certain amount of the token of their choice on a regular basis (daily, weekly or monthly).

1 - The following endpoints, allows you to create a new DCA by specifying the original token, the destination token, the frequency of the transactions:

POST/v1/dca

Body

application/json

jwtJwt (object)

viewDCACreateView (object)

Response

200

OK

Body

*/*

successboolean

dataDCAView (object)

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

const response = await fetch('/v1/dca', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "accountId": "text",
    "id": "text",
    "creationTs": "2024-07-27T13:03:55.426Z",
    "status": "ACTIVE",
    "quantity": 0,
    "fromCoin": {
      "slug": "text",
      "name": "text",
      "logoUrl": "text",
      "availableNetworks": [
        "text"
      ]
    },
    "toCoin": {
      "slug": "text",
      "name": "text",
      "logoUrl": "text",
      "availableNetworks": [
        "text"
      ]
    },
    "frequency": "DAILY"
  },
  "errorMessage": "text"
}

OAuth : user_auth

2 - The following endpoint, allows you to consult the active DCAs on an AccountId:

GET/v1/dca

Query parameters

Response

200

OK

Body

*/*

successboolean

dataarray of DCAView (object)

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

const response = await fetch('/v1/dca', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "data": [
    {
      "accountId": "text",
      "id": "text",
      "creationTs": "2024-07-27T13:03:55.426Z",
      "status": "ACTIVE",
      "quantity": 0,
      "fromCoin": {
        "slug": "text",
        "name": "text",
        "logoUrl": "text",
        "availableNetworks": [
          "text"
        ]
      },
      "toCoin": {
        "slug": "text",
        "name": "text",
        "logoUrl": "text",
        "availableNetworks": [
          "text"
        ]
      },
      "frequency": "DAILY"
    }
  ],
  "errorMessage": "text"
}

OAuth : user_auth

3 - Finally, this endpoint will give you the possibility to activate/deactivate a DCA:

PUT/v1/dca/{id}/{status}

Path parameters

id*string

status*enum

ACTIVEINACTIVE

Body

application/json

tokenValuestring

issuedAtstring (date-time)

expiresAtstring (date-time)

headersobject

claimsobject

idstring

issuerstring (url)

notBeforestring (date-time)

subjectstring

audiencearray of string

Response

200

OK

Body

*/*

successboolean

dataDCAView (object)

errorCodeinteger (int32)

errorMessagestring

Request

JavaScriptCurl

const response = await fetch('/v1/dca/{id}/{status}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "accountId": "text",
    "id": "text",
    "creationTs": "2024-07-27T13:03:55.426Z",
    "status": "ACTIVE",
    "quantity": 0,
    "fromCoin": {
      "slug": "text",
      "name": "text",
      "logoUrl": "text",
      "availableNetworks": [
        "text"
      ]
    },
    "toCoin": {
      "slug": "text",
      "name": "text",
      "logoUrl": "text",
      "availableNetworks": [
        "text"
      ]
    },
    "frequency": "DAILY"
  },
  "errorMessage": "text"
}

OAuth : user_auth