Whuffies

List markets v2 with pagination and sorting

get

Query parameters

orderBystring · enumOptionalDefault: volumeTotalCreditsPossible values:

orderDirectionstring · enumOptionalDefault: descPossible values:

filterQuerystring · min: 2 · max: 100Optional

limitinteger · min: 1 · max: 100OptionalDefault: 50

cursorinteger · min: -9007199254740991 · max: 9007199254740991Optional

Responses

200

Successful response

application/json

nextCursorany ofRequired

numberOptional

or

nullOptional

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/whuffies

HTTPcURLJavaScriptPython

GET /api/v2/whuffies HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "values": [
    {
      "id": 1,
      "marketOnchainId": 1,
      "userkey": "text",
      "subject": {
        "id": 1,
        "profileId": 1,
        "displayName": "text",
        "username": "text",
        "avatarUrl": "https://example.com",
        "description": "text",
        "score": 1,
        "status": "ACTIVE",
        "userkeys": [
          "text"
        ],
        "xpTotal": 1,
        "xpStreakDays": 1,
        "xpRemovedDueToAbuse": true,
        "influenceFactor": 1,
        "influenceFactorPercentile": 1,
        "humanVerificationStatus": "REQUESTED",
        "validatorNftCount": 1,
        "links": {
          "profile": "https://example.com",
          "scoreBreakdown": "https://example.com"
        },
        "stats": {
          "review": {
            "received": {
              "negative": 1,
              "neutral": 1,
              "positive": 1
            }
          },
          "vouch": {
            "given": {
              "amountWeiTotal": 1,
              "count": 1
            },
            "received": {
              "amountWeiTotal": 1,
              "count": 1
            }
          }
        }
      },
      "creatorAddress": "text",
      "trustPrice": 1,
      "distrustPrice": 1,
      "trustSupply": 1,
      "distrustSupply": 1,
      "poolBacking": 1,
      "volumeTotalCredits": 1,
      "volume24hCredits": 1,
      "priceChange24hPercent": 1,
      "createdAt": "text"
    }
  ],
  "nextCursor": 1
}

Get a single market v2 by on-chain ID

get

Path parameters

marketOnchainIdinteger · max: 9007199254740991Required

Responses

200

Successful response

application/json

or

nullOptional

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/whuffies/{marketOnchainId}

HTTPcURLJavaScriptPython

GET /api/v2/whuffies/{marketOnchainId} HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "id": 1,
  "marketOnchainId": 1,
  "userkey": "text",
  "subject": {
    "id": 1,
    "profileId": 1,
    "displayName": "text",
    "username": "text",
    "avatarUrl": "https://example.com",
    "description": "text",
    "score": 1,
    "status": "ACTIVE",
    "userkeys": [
      "text"
    ],
    "xpTotal": 1,
    "xpStreakDays": 1,
    "xpRemovedDueToAbuse": true,
    "influenceFactor": 1,
    "influenceFactorPercentile": 1,
    "humanVerificationStatus": "REQUESTED",
    "validatorNftCount": 1,
    "links": {
      "profile": "https://example.com",
      "scoreBreakdown": "https://example.com"
    },
    "stats": {
      "review": {
        "received": {
          "negative": 1,
          "neutral": 1,
          "positive": 1
        }
      },
      "vouch": {
        "given": {
          "amountWeiTotal": 1,
          "count": 1
        },
        "received": {
          "amountWeiTotal": 1,
          "count": 1
        }
      }
    }
  },
  "creatorAddress": "text",
  "trustPrice": 1,
  "distrustPrice": 1,
  "trustSupply": 1,
  "distrustSupply": 1,
  "poolBacking": 1,
  "volumeTotalCredits": 1,
  "volume24hCredits": 1,
  "priceChange24hPercent": 1,
  "createdAt": "text",
  "pricingContract": "text",
  "trustToken": "text",
  "distrustToken": "text"
}

Get trade history for a market v2

get

Path parameters

marketOnchainIdinteger · max: 9007199254740991Required

Query parameters

traderAddressstringOptional

Ethereum address (0x-prefixed, 20 bytes)

limitinteger · min: 1 · max: 100OptionalDefault: 50

cursorinteger · min: -9007199254740991 · max: 9007199254740991Optional

Responses

200

Successful response

application/json

nextCursorany ofRequired

numberOptional

or

nullOptional

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/whuffies/{marketOnchainId}/trade-history

HTTPcURLJavaScriptPython

GET /api/v2/whuffies/{marketOnchainId}/trade-history HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "values": [
    {
      "id": 1,
      "type": "BUY",
      "traderAddress": "text",
      "trader": {
        "id": 1,
        "profileId": 1,
        "displayName": "text",
        "username": "text",
        "avatarUrl": "https://example.com",
        "description": "text",
        "score": 1,
        "status": "ACTIVE",
        "userkeys": [
          "text"
        ],
        "xpTotal": 1,
        "xpStreakDays": 1,
        "xpRemovedDueToAbuse": true,
        "influenceFactor": 1,
        "influenceFactorPercentile": 1,
        "humanVerificationStatus": "REQUESTED",
        "validatorNftCount": 1,
        "links": {
          "profile": "https://example.com",
          "scoreBreakdown": "https://example.com"
        },
        "stats": {
          "review": {
            "received": {
              "negative": 1,
              "neutral": 1,
              "positive": 1
            }
          },
          "vouch": {
            "given": {
              "amountWeiTotal": 1,
              "count": 1
            },
            "received": {
              "amountWeiTotal": 1,
              "count": 1
            }
          }
        }
      },
      "isPositive": true,
      "paymentAmount": 1,
      "tokenAmount": 1,
      "createdAt": "text"
    }
  ],
  "nextCursor": 1
}

Get bucketed trust/distrust price history for a market v2

get

Path parameters

marketOnchainIdinteger · max: 9007199254740991Required

Query parameters

durationstring · enumOptionalDefault: 7dPossible values:

Responses

200

Successful response

application/json

durationstring · enumRequiredPossible values:

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/whuffies/{marketOnchainId}/price-history

HTTPcURLJavaScriptPython

GET /api/v2/whuffies/{marketOnchainId}/price-history HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "duration": "1h",
  "values": [
    {
      "timeBucket": "text",
      "trustPrice": 1,
      "distrustPrice": 1
    }
  ]
}

Get globally-recent trades across all markets v2

get

Query parameters

limitinteger · min: 1 · max: 50OptionalDefault: 20

Responses

200

Successful response

application/json

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/whuffies/recent-trades

HTTPcURLJavaScriptPython

GET /api/v2/whuffies/recent-trades HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "values": [
    {
      "id": 1,
      "type": "BUY",
      "traderAddress": "text",
      "trader": {
        "id": 1,
        "profileId": 1,
        "displayName": "text",
        "username": "text",
        "avatarUrl": "https://example.com",
        "description": "text",
        "score": 1,
        "status": "ACTIVE",
        "userkeys": [
          "text"
        ],
        "xpTotal": 1,
        "xpStreakDays": 1,
        "xpRemovedDueToAbuse": true,
        "influenceFactor": 1,
        "influenceFactorPercentile": 1,
        "humanVerificationStatus": "REQUESTED",
        "validatorNftCount": 1,
        "links": {
          "profile": "https://example.com",
          "scoreBreakdown": "https://example.com"
        },
        "stats": {
          "review": {
            "received": {
              "negative": 1,
              "neutral": 1,
              "positive": 1
            }
          },
          "vouch": {
            "given": {
              "amountWeiTotal": 1,
              "count": 1
            },
            "received": {
              "amountWeiTotal": 1,
              "count": 1
            }
          }
        }
      },
      "isPositive": true,
      "paymentAmount": 1,
      "tokenAmount": 1,
      "createdAt": "text",
      "market": {
        "marketOnchainId": 1,
        "userkey": "text",
        "subject": {
          "id": 1,
          "profileId": 1,
          "displayName": "text",
          "username": "text",
          "avatarUrl": "https://example.com",
          "description": "text",
          "score": 1,
          "status": "ACTIVE",
          "userkeys": [
            "text"
          ],
          "xpTotal": 1,
          "xpStreakDays": 1,
          "xpRemovedDueToAbuse": true,
          "influenceFactor": 1,
          "influenceFactorPercentile": 1,
          "humanVerificationStatus": "REQUESTED",
          "validatorNftCount": 1,
          "links": {
            "profile": "https://example.com",
            "scoreBreakdown": "https://example.com"
          },
          "stats": {
            "review": {
              "received": {
                "negative": 1,
                "neutral": 1,
                "positive": 1
              }
            },
            "vouch": {
              "given": {
                "amountWeiTotal": 1,
                "count": 1
              },
              "received": {
                "amountWeiTotal": 1,
                "count": 1
              }
            }
          }
        }
      }
    }
  ]
}

List holders of a market v2, sorted by balance desc

get

Path parameters

marketOnchainIdinteger · max: 9007199254740991Required

Query parameters

sidestring · enumOptionalPossible values:

limitinteger · min: 1 · max: 100OptionalDefault: 50

cursorinteger · min: -9007199254740991 · max: 9007199254740991Optional

Responses

200

Successful response

application/json

nextCursorany ofRequired

numberOptional

or

nullOptional

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/whuffies/{marketOnchainId}/holders

HTTPcURLJavaScriptPython

GET /api/v2/whuffies/{marketOnchainId}/holders HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "values": [
    {
      "traderAddress": "text",
      "trader": {
        "id": 1,
        "profileId": 1,
        "displayName": "text",
        "username": "text",
        "avatarUrl": "https://example.com",
        "description": "text",
        "score": 1,
        "status": "ACTIVE",
        "userkeys": [
          "text"
        ],
        "xpTotal": 1,
        "xpStreakDays": 1,
        "xpRemovedDueToAbuse": true,
        "influenceFactor": 1,
        "influenceFactorPercentile": 1,
        "humanVerificationStatus": "REQUESTED",
        "validatorNftCount": 1,
        "links": {
          "profile": "https://example.com",
          "scoreBreakdown": "https://example.com"
        },
        "stats": {
          "review": {
            "received": {
              "negative": 1,
              "neutral": 1,
              "positive": 1
            }
          },
          "vouch": {
            "given": {
              "amountWeiTotal": 1,
              "count": 1
            },
            "received": {
              "amountWeiTotal": 1,
              "count": 1
            }
          }
        }
      },
      "isPositive": true,
      "balance": 1,
      "firstTradeAt": "text"
    }
  ],
  "nextCursor": 1
}

Get WHUF token balance for an address

get

Path parameters

addressstringRequired

Ethereum address (0x-prefixed, 20 bytes)

Responses

200

Successful response

application/json

balanceinteger · int64Required

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/whuffies/balance/{address}

HTTPcURLJavaScriptPython

GET /api/v2/whuffies/balance/{address} HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "balance": 1
}

Get a user’s position in a market

get

Path parameters

marketOnchainIdinteger · max: 9007199254740991Required

Query parameters

isPositivebooleanRequired

userAddressstringRequired

Ethereum address (0x-prefixed, 20 bytes)

Responses

200

Successful response

application/json

balanceinteger · int64Required

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/whuffies/{marketOnchainId}/position

HTTPcURLJavaScriptPython

GET /api/v2/whuffies/{marketOnchainId}/position?isPositive=true&userAddress=text HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "balance": 1
}

Simulate opening a position on a market v2

get

Path parameters

marketOnchainIdinteger · max: 9007199254740991Required

Query parameters

isPositivebooleanRequired

paymentAmountinteger · int64Required

slippagePercentagenumber · max: 0.5OptionalDefault: 0.01

Responses

200

Successful response

application/json

tokensMintedinteger · int64Required

minTokensOutinteger · int64Required

protocolFeeinteger · int64Required

effectivePriceinteger · int64Required

priceImpactPctnumberRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/whuffies/{marketOnchainId}/simulate-open-position

HTTPcURLJavaScriptPython

GET /api/v2/whuffies/{marketOnchainId}/simulate-open-position?isPositive=true&paymentAmount=1 HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "tokensMinted": 1,
  "minTokensOut": 1,
  "protocolFee": 1,
  "effectivePrice": 1,
  "priceImpactPct": 1
}

Simulate closing a position on a market v2

get

Path parameters

marketOnchainIdinteger · max: 9007199254740991Required

Query parameters

isPositivebooleanRequired

positionTokenAmountinteger · int64Required

sellerAddressstringRequired

Ethereum address (0x-prefixed, 20 bytes)

slippagePercentagenumber · max: 0.5OptionalDefault: 0.01

Responses

200

Successful response

application/json

netCreditsOutinteger · int64Required

minCreditsOutinteger · int64Required

curveRevenueinteger · int64Required

bonusShareinteger · int64Required

couplingFeeinteger · int64Required

exitFeeinteger · int64Required

effectivePriceinteger · int64Required

priceImpactPctnumberRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/whuffies/{marketOnchainId}/simulate-close-position

HTTPcURLJavaScriptPython

GET /api/v2/whuffies/{marketOnchainId}/simulate-close-position?isPositive=true&positionTokenAmount=1&sellerAddress=text HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "netCreditsOut": 1,
  "minCreditsOut": 1,
  "curveRevenue": 1,
  "bonusShare": 1,
  "couplingFee": 1,
  "exitFee": 1,
  "effectivePrice": 1,
  "priceImpactPct": 1
}