Markets

List markets with pagination, sorting, and filtering

get

Query parameters

orderBystring · enumOptionalDefault: createdAtPossible values:

orderDirectionstring · enumOptionalDefault: descPossible values:

dayRangeinteger · min: 1 · max: 90 · nullableOptionalDefault: null

filterQuerystringOptional

limitinteger · max: 100OptionalDefault: 50

offsetinteger · max: 2147483647OptionalDefault: 0

Responses

200

Successful response

application/json

totalnumberRequired

limitnumberRequired

offsetnumberRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/markets

HTTPcURLJavaScriptPython

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

{
  "values": [
    {
      "id": 1,
      "creatorAddress": "text",
      "positivePrice": "text",
      "negativePrice": "text",
      "trustVotes": 1,
      "distrustVotes": 1,
      "createdAt": "text",
      "updatedAt": "text",
      "basePrice": "text",
      "creationCost": "text",
      "liquidity": "text",
      "configType": "VOLATILE",
      "user": {
        "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
            }
          }
        }
      },
      "stats": {
        "marketCapWei": "text",
        "marketCapChange24hWei": "text",
        "marketCapChange24hPercent": 1,
        "volumeTotalWei": "text",
        "volume24hWei": "text",
        "priceChange24hPercent": 1
      }
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

Get featured markets

get

Query parameters

changeTypestring · enumOptionalDefault: priceChange24hPercentPossible values:

excludeUnverifiedbooleanOptional

Responses

200

Successful response

application/json

typestring · enumRequiredPossible values:

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/markets/featured

HTTPcURLJavaScriptPython

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

[
  {
    "type": "top-volume",
    "market": {
      "id": 1,
      "creatorAddress": "text",
      "positivePrice": "text",
      "negativePrice": "text",
      "trustVotes": 1,
      "distrustVotes": 1,
      "createdAt": "text",
      "updatedAt": "text",
      "basePrice": "text",
      "creationCost": "text",
      "liquidity": "text",
      "configType": "VOLATILE",
      "user": {
        "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
            }
          }
        }
      },
      "stats": {
        "marketCapWei": "text",
        "marketCapChange24hWei": "text",
        "marketCapChange24hPercent": 1,
        "volumeTotalWei": "text",
        "volume24hWei": "text",
        "priceChange24hPercent": 1
      }
    }
  }
]

Get market holders with user data

get

Path parameters

profileIdinteger · max: 2147483647Required

Query parameters

dedupeByUserbooleanOptionalDefault: false

voteTypestring · enumOptionalPossible values:

orderBystring · enumOptionalDefault: holdingsPossible values:

orderDirectionstring · enumOptionalDefault: descPossible values:

limitinteger · max: 500OptionalDefault: 50

offsetinteger · max: 2147483647OptionalDefault: 0

Responses

200

Successful response

application/json

totalnumberRequired

limitnumberRequired

offsetnumberRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/markets/{profileId}/holders

HTTPcURLJavaScriptPython

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

{
  "values": [
    {
      "actorAddress": "text",
      "marketId": 1,
      "voteType": "trust",
      "total": 1,
      "user": {
        "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
            }
          }
        }
      }
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

Get market price history for chart with advanced features

get

Path parameters

profileIdinteger · max: 2147483647Required

Query parameters

timeWindowstring · enumOptionalDefault: 7DPossible values:

customBucketstring · enumOptionalPossible values:

Responses

200

Successful response

application/json

timeWindowstring · enumRequiredPossible values:

bucketstring · enumRequiredPossible values:

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/markets/{profileId}/price/history

HTTPcURLJavaScriptPython

GET /api/v2/markets/{profileId}/price/history HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "data": [
    {
      "timeBucket": "text",
      "price": {
        "trustWei": 1,
        "distrustWei": 1,
        "trustUsd": 1,
        "distrustUsd": 1,
        "totalWei": 1,
        "totalUsd": 1
      },
      "marketCap": {
        "trustWei": 1,
        "distrustWei": 1,
        "trustUsd": 1,
        "distrustUsd": 1,
        "totalWei": 1,
        "totalUsd": 1
      }
    }
  ],
  "timeWindow": "1H",
  "bucket": "30 seconds"
}

Simulate trust market purchase

get

Query parameters

profileIdinteger · max: 2147483647Required

voteTypestring · enumRequiredPossible values:

buyAmountWeiinteger · int64Required

slippagePercentagenumber · max: 1OptionalDefault: 0.01

Responses

200

Successful response

application/json

impactPctnumberRequired

maxVotesToBuyinteger · max: 9007199254740991Required

minVotesToBuyinteger · max: 9007199254740991Required

newPriceinteger · int64Required

trendstring · enum · nullableRequiredPossible values:

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/markets/simulate-buy

HTTPcURLJavaScriptPython

GET /api/v2/markets/simulate-buy?profileId=1&voteType=trust&buyAmountWei=1 HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "impactPct": 1,
  "maxVotesToBuy": 1,
  "minVotesToBuy": 1,
  "newPrice": 1,
  "trend": "up"
}

Simulate market vote sell

get

Query parameters

profileIdinteger · max: 2147483647Required

voteTypestring · enumRequiredPossible values:

votesinteger · max: 9007199254740991Required

sellerAddressstringRequired

Ethereum address (0x-prefixed, 20 bytes)

slippagePercentagenumber · max: 1OptionalDefault: 0.01

Responses

200

Successful response

application/json

fundsReceivedinteger · int64Required

minimumVotePriceinteger · int64Required

newVotePriceinteger · int64Required

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/markets/simulate-sell

HTTPcURLJavaScriptPython

GET /api/v2/markets/simulate-sell?profileId=1&voteType=trust&votes=1&sellerAddress=text HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "fundsReceived": 1,
  "minimumVotePrice": 1,
  "newVotePrice": 1
}

Get market change (market cap or price) data over specified days

get

Supports market cap and price change calculations. Volume change coming soon.

Path parameters

profileIdinteger · max: 2147483647Required

Query parameters

daysinteger · min: 1 · max: 90OptionalDefault: 7

typestring · enumOptionalDefault: marketCapPossible values:

Responses

200

Successful response

application/json

profileIdnumberRequired

daysnumberRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/markets/{profileId}/change

HTTPcURLJavaScriptPython

GET /api/v2/markets/{profileId}/change HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "profileId": 1,
  "change": {
    "trust": {
      "latestWei": 1,
      "latestUsd": 1,
      "changeWei": 1,
      "changeUsd": 1,
      "changePercent": 1
    },
    "distrust": {
      "latestWei": 1,
      "latestUsd": 1,
      "changeWei": 1,
      "changeUsd": 1,
      "changePercent": 1
    },
    "total": {
      "latestWei": 1,
      "latestUsd": 1,
      "changeWei": 1,
      "changeUsd": 1,
      "changePercent": 1
    }
  },
  "days": 1
}

Get enhanced market info with optional includes

post

Enhanced market info with optional top holders and market change data

Path parameters

profileIdinteger · max: 2147483647Required

Body

application/json

marketTopHoldersLimitinteger · max: 10OptionalDefault: 0

Responses

200

Successful response

application/json

idinteger · max: 9007199254740991Required

creatorAddressstringRequired

positivePricestringRequired

negativePricestringRequired

trustVotesnumberRequired

distrustVotesnumberRequired

createdAtstringRequired

updatedAtstringRequired

basePricestringRequired

creationCoststringRequired

liquiditystringRequired

configTypestring · enumRequiredPossible values:

400

Invalid input data

application/json

500

Internal server error

application/json

post/markets/{profileId}/info

HTTPcURLJavaScriptPython

POST /api/v2/markets/{profileId}/info HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "marketTopHoldersLimit": 0,
  "marketChangeParams": {
    "type": "marketCap",
    "days": 7
  }
}

{
  "id": 1,
  "creatorAddress": "text",
  "positivePrice": "text",
  "negativePrice": "text",
  "trustVotes": 1,
  "distrustVotes": 1,
  "createdAt": "text",
  "updatedAt": "text",
  "basePrice": "text",
  "creationCost": "text",
  "liquidity": "text",
  "configType": "VOLATILE",
  "user": {
    "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
        }
      }
    }
  },
  "stats": {
    "marketCapWei": "text",
    "marketCapChange24hWei": "text",
    "marketCapChange24hPercent": 1,
    "volumeTotalWei": "text",
    "volume24hWei": "text",
    "priceChange24hPercent": 1
  },
  "marketTopHolders": {
    "trust": [
      {
        "actorAddress": "text",
        "marketId": 1,
        "voteType": "trust",
        "total": 1,
        "user": {
          "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
              }
            }
          }
        }
      }
    ],
    "distrust": [
      {
        "actorAddress": "text",
        "marketId": 1,
        "voteType": "trust",
        "total": 1,
        "user": {
          "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
              }
            }
          }
        }
      }
    ]
  },
  "marketChange": {
    "profileId": 1,
    "change": {
      "trust": {
        "latestWei": 1,
        "latestUsd": 1,
        "changeWei": 1,
        "changeUsd": 1,
        "changePercent": 1
      },
      "distrust": {
        "latestWei": 1,
        "latestUsd": 1,
        "changeWei": 1,
        "changeUsd": 1,
        "changePercent": 1
      },
      "total": {
        "latestWei": 1,
        "latestUsd": 1,
        "changeWei": 1,
        "changeUsd": 1,
        "changePercent": 1
      }
    },
    "days": 1
  }
}

Get market info for multiple markets by profile IDs

get

Query parameters

profileIdsinteger[] · max: 500Required

Responses

200

Successful response

application/json

idinteger · max: 9007199254740991Required

creatorAddressstringRequired

positivePricestringRequired

negativePricestringRequired

trustVotesnumberRequired

distrustVotesnumberRequired

createdAtstringRequired

updatedAtstringRequired

basePricestringRequired

creationCoststringRequired

liquiditystringRequired

configTypestring · enumRequiredPossible values:

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/markets/info/bulk

HTTPcURLJavaScriptPython

GET /api/v2/markets/info/bulk?profileIds=1 HTTP/1.1
Host: api.ethos.network
Accept: */*

[
  {
    "id": 1,
    "creatorAddress": "text",
    "positivePrice": "text",
    "negativePrice": "text",
    "trustVotes": 1,
    "distrustVotes": 1,
    "createdAt": "text",
    "updatedAt": "text",
    "basePrice": "text",
    "creationCost": "text",
    "liquidity": "text",
    "configType": "VOLATILE",
    "user": {
      "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
          }
        }
      }
    },
    "stats": {
      "marketCapWei": "text",
      "marketCapChange24hWei": "text",
      "marketCapChange24hPercent": 1,
      "volumeTotalWei": "text",
      "volume24hWei": "text",
      "priceChange24hPercent": 1
    }
  }
]

Get markets user by the embedded wallet address used on ethos.markets

get

Path parameters

addressstringRequired

Ethereum address (0x-prefixed, 20 bytes)

Responses

200

Successful response

application/json

profileIdinteger · max: 2147483647 · nullableRequired

twitterUsernamestringRequired

twitterNamestringRequired

twitterUserIdstringRequired

walletAddressstring · nullableRequired

Ethereum address (0x-prefixed, 20 bytes)

avatarUrlstringRequired

createdAtstringRequired

updatedAtstringRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/markets/users/by/address/{address}

HTTPcURLJavaScriptPython

GET /api/v2/markets/users/by/address/{address} HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "profileId": 1,
  "twitterUsername": "text",
  "twitterName": "text",
  "twitterUserId": "text",
  "walletAddress": "text",
  "avatarUrl": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

Get markets user by Twitter username

get

Path parameters

usernamestringRequired

Responses

200

Successful response

application/json

profileIdinteger · max: 2147483647 · nullableRequired

twitterUsernamestringRequired

twitterNamestringRequired

twitterUserIdstringRequired

walletAddressstring · nullableRequired

Ethereum address (0x-prefixed, 20 bytes)

avatarUrlstringRequired

createdAtstringRequired

updatedAtstringRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/markets/users/by/x/{username}

HTTPcURLJavaScriptPython

GET /api/v2/markets/users/by/x/{username} HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "profileId": 1,
  "twitterUsername": "text",
  "twitterName": "text",
  "twitterUserId": "text",
  "walletAddress": "text",
  "avatarUrl": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

Resolve market trading addresses to users with emporos and echo data

post

Body

application/json

addressesstring[] · min: 1 · max: 500Required

Ethereum address (0x-prefixed, 20 bytes)

Responses

200

Successful response

application/json

addressstringRequired

Ethereum address (0x-prefixed, 20 bytes)

400

Invalid input data

application/json

500

Internal server error

application/json

post/markets/users/by/addresses

HTTPcURLJavaScriptPython

POST /api/v2/markets/users/by/addresses HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "addresses": [
    "text"
  ]
}

[
  {
    "address": "text",
    "marketUser": {
      "twitterUserId": "text",
      "twitterUsername": "text",
      "twitterName": "text",
      "avatarUrl": "text",
      "createdAt": "text"
    },
    "user": {
      "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
          }
        }
      }
    }
  }
]

Get market configurations for market creation and display

get

Responses

200

Successful response

application/json

basePriceinteger · int64Required

configIndexnumberRequired

creationCostinteger · int64Required

liquidityinteger · int64Required

500

Internal server error

application/json

get/markets/configs

HTTPcURLJavaScriptPython

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

[
  {
    "basePrice": 1,
    "configIndex": 1,
    "creationCost": 1,
    "liquidity": 1
  }
]

Get market buy and sell fee percentages

get

Responses

200

Successful response

application/json

donationFeePercentagenumberRequired

entryProtocolFeePercentagenumberRequired

exitProtocolFeePercentagenumberRequired

500

Internal server error

application/json

get/markets/fees

HTTPcURLJavaScriptPython

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

{
  "donationFeePercentage": 1,
  "entryProtocolFeePercentage": 1,
  "exitProtocolFeePercentage": 1
}

Get current vote price for a market

get

Path parameters

profileIdinteger · max: 2147483647Required

Query parameters

voteTypestring · enumRequiredPossible values:

Responses

200

Successful response

application/json

priceinteger · int64Required

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/markets/{profileId}/vote-price

HTTPcURLJavaScriptPython

GET /api/v2/markets/{profileId}/vote-price?voteType=trust HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "price": 1
}

Get vote counts owned by a user in a market

get

Path parameters

profileIdinteger · max: 2147483647Required

Query parameters

userAddressstringRequired

Ethereum address (0x-prefixed, 20 bytes)

Responses

200

Successful response

application/json

distrustVotesinteger · max: 9007199254740991Required

trustVotesinteger · max: 9007199254740991Required

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/markets/{profileId}/user-votes

HTTPcURLJavaScriptPython

GET /api/v2/markets/{profileId}/user-votes?userAddress=text HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "distrustVotes": 1,
  "trustVotes": 1
}

Get paginated open market positions for a user by userkey

get

Open market positions across all of the user’s trading wallets (profile-linked addresses, EEW, and the linked ethos.markets embedded wallet). Each row represents one (market, voteType) position summed across wallets.

Query parameters

holderUserkeystringRequired

marketProfileIdinteger · max: 2147483647Optional

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

cursorinteger · max: 9007199254740991Optional

Responses

200

Successful response

application/json

nextCursornumber · nullableRequired

totalinteger · max: 9007199254740991Required

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/markets/holdings

HTTPcURLJavaScriptPython

GET /api/v2/markets/holdings?holderUserkey=text HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "values": [
    {
      "marketProfileId": 1,
      "user": {
        "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
            }
          }
        }
      },
      "voteType": "trust",
      "currentHoldingVotes": 1,
      "currentHoldingValue": 1,
      "totalPnl": 1,
      "totalPnlPercent": 1
    }
  ],
  "nextCursor": 1,
  "total": 1
}

Get aggregate market stats for a user by userkey

get

Portfolio value and total PNL summed across all of the user’s trading wallets (profile-linked addresses, EEW, and the linked ethos.markets embedded wallet). Portfolio value only includes open positions; total PNL includes realized and unrealized PNL.

Query parameters

holderUserkeystringRequired

Responses

200

Successful response

application/json

marketsPortfolioValueinteger · int64Required

totalPnlinteger · int64Required

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get/markets/stats

HTTPcURLJavaScriptPython

GET /api/v2/markets/stats?holderUserkey=text HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "marketsPortfolioValue": 1,
  "totalPnl": 1
}