Public
Documentation Settings

Ecrumena - public API

To access the Ecrumeny API, you need to register and create an account. Once logged in, navigate to the settings section to generate your unique API key. This key must be included in all your API requests as a token parameter to authenticate and authorize your access. Below, you'll find an image illustrating where you can generate your API key.

Ecrumena%20API%20key

Ecrumena API key

v1

Introducing the first version of the Ecrumeny API, which provides developers with access to asset sentiment analysis and historical data. This initial release features endpoints that deliver detailed sentiment scores, labels, related news articles, and comprehensive historical values, volumes, and timestamps for assets. Begin integrating Ecrumeny data into your applications now.

GETGet Assets

https://api.ecrumena.com/api/v1/assets?token=<token>&currency=pln

The endpoint retrieves a list of assets with the specified currency. The response is a JSON object containing an array of assets, each including information such as ticker, name, exchange, country, portfolio, value, volume, currency, created_at, and latest_synchronization.

Response:
json
{
  "type": "object",
  "properties": {
    "assets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ticker": { "type": "string" },
          "name": { "type": "string" },
          "exchange": { "type": ["string", "null"] },
          "country": { "type": ["string", "null"] },
          "portfolio": { "type": "string" },
          "value": { "type": "number" },
          "purchase_value": { "type": "number" },
          "volume": { "type": "number" },
          "currency": { "type": "string" },
          "created_at": { "type": "string" },
          "latest_synchronization": { "type": "string" }
        },
        "required": ["ticker", "name", "exchange", "country", "portfolio", "value", "volume", "currency", "created_at", "latest_synchronization"]
      }
    }
  },
  "required": ["assets"]
}
PARAMS
token

<token>

currency

pln

GETGet Assets History

https://api.ecrumena.com/api/v1/assets/history?token=<token>&currency=pln

The endpoint retrieves historical data for assets with the specified currency. The response is a JSON object containing an array of assets, each including information such as ticker, name, exchange, country, portfolio, historical values, historical volumes, currency, and timestamps.

Response:
json
{
  "type": "object",
  "properties": {
    "assets_history": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ticker": { "type": "string" },
          "name": { "type": "string" },
          "exchange": { "type": ["string", "null"] },
          "country": { "type": ["string", "null"] },
          "portfolio": { "type": "string" },
          "value": { "type": "number" },
          "volume": { "type": "number" },
          "currency": { "type": "string" },
          "created_at": { "type": "string" }
        },
        "required": ["ticker", "name", "exchange", "country", "portfolio", "value", "volume", "currency", "created_at"]
      }
    }
  },
  "required": ["assets_history"]
}
PARAMS
token

<token>

currency

pln

Loading