⚙️External API (Gitbook)

The base URL of the external API of Aktionariat is: https://ext.aktionariat.com/

At the moment the following three endpoints are available:

• /token - for token details

• /price - for the current price

• /prices - for historical prices

In the following you see the API specification of the different calls you can make.

Download OpenAPI specification:

7KB

openapi.yaml

Open

Getting all tokens from Aktionariat

Get all tokens

get

Get all tokens that are registered in the Aktionariat back-end.

Responses

200

Successful operation

application/jsonapplication/xml

tickerstringOptional

Ticker of the Shares

Example: DAKS

namestringOptional

Name of the Shares

Example: Draggable Aktionariart AG Shares

descriptionstringOptionalExample: Aktionariat is a tokenization platform.

chainstringOptional

the blockchain the token resides on

Example: mainnet

registerstringOptional

the contract address of the token

Example: 0x6f38e0f1a73c96cb3f42598613ea3474f09cb200

marketstringOptional

The link to the investor page

Example: https://investors.aktionariat.com

creationintegerOptional

Creation timestamp

currencystringOptional

The base currency

Example: CHF

statusstringOptional

Traded Status

Example: TRADED

tokenTypestringOptional

Type of token

Example: EQUITY

urlstringOptional

The link to the investor page

Example: https://investors.aktionariat.com

totalSupplyintegerOptionalExample: 1330000

marketCapintegerOptional

Market Cap in base currency

Example: 18535743

400

Token not found

404

Not Found

get

/tokens/

HTTPcURLJavaScriptPython

GET /tokens/ HTTP/1.1
Host: ext.aktionariat.com
Accept: */*

[
  {
    "ticker": "DAKS",
    "name": "Draggable Aktionariart AG Shares",
    "description": "Aktionariat is a tokenization platform.",
    "chain": "mainnet",
    "register": "0x6f38e0f1a73c96cb3f42598613ea3474f09cb200",
    "market": "https://investors.aktionariat.com",
    "creation": 1,
    "currency": "CHF",
    "status": "TRADED",
    "tokenType": "EQUITY",
    "url": "https://investors.aktionariat.com",
    "totalSupply": 1330000,
    "marketCap": 18535743,
    "issuer": {
      "name": "Aktionariat AG",
      "description": "Aktionariat is a tokenization platfrom for security tokens",
      "url": "www.aktionariat.com",
      "industry": "Fintech",
      "foundingYear": 2020
    }
  }
]

Getting token details for a specific ticker

Get token details

get

Get tokens details for the ticker in the query.

Query parameters

tickerstringRequired

The ticker of the share token (Uppercase)

Example: DAKS

Responses

200

Successful operation

application/jsonapplication/xml

tickerstringOptional

Ticker of the Shares

Example: DAKS

namestringOptional

Name of the Shares

Example: Draggable Aktionariart AG Shares

descriptionstringOptionalExample: Aktionariat is a tokenization platform.

chainstringOptional

the blockchain the token resides on

Example: mainnet

registerstringOptional

the contract address of the token

Example: 0x6f38e0f1a73c96cb3f42598613ea3474f09cb200

marketstringOptional

The link to the investor page

Example: https://investors.aktionariat.com

creationintegerOptional

Creation timestamp

currencystringOptional

The base currency

Example: CHF

statusstringOptional

Traded Status

Example: TRADED

tokenTypestringOptional

Type of token

Example: EQUITY

urlstringOptional

The link to the investor page

Example: https://investors.aktionariat.com

totalSupplyintegerOptionalExample: 1330000

marketCapintegerOptional

Market Cap in base currency

Example: 18535743

400

Token not found

get

/tokens

HTTPcURLJavaScriptPython

GET /tokens?ticker=text HTTP/1.1
Host: ext.aktionariat.com
Accept: */*

{
  "ticker": "DAKS",
  "name": "Draggable Aktionariart AG Shares",
  "description": "Aktionariat is a tokenization platform.",
  "chain": "mainnet",
  "register": "0x6f38e0f1a73c96cb3f42598613ea3474f09cb200",
  "market": "https://investors.aktionariat.com",
  "creation": 1,
  "currency": "CHF",
  "status": "TRADED",
  "tokenType": "EQUITY",
  "url": "https://investors.aktionariat.com",
  "totalSupply": 1330000,
  "marketCap": 18535743,
  "issuer": {
    "name": "Aktionariat AG",
    "description": "Aktionariat is a tokenization platfrom for security tokens",
    "url": "www.aktionariat.com",
    "industry": "Fintech",
    "foundingYear": 2020
  }
}

Get current price of a token

Get current price

get

Get current price with the according currency for a token.

Query parameters

tickerstringRequired

The ticker of the share token (Uppercase)

Example: DAKS

Responses

200

Successful operation

application/jsonapplication/xml

pricenumberOptional

Price of the share

Example: 13.432

basestringOptional

base currency

Example: CHF

400

No asset found for given criteria

get

/price

HTTPcURLJavaScriptPython

GET /price?ticker=text HTTP/1.1
Host: ext.aktionariat.com
Accept: */*

{
  "price": 13.432,
  "base": "CHF"
}

Get price history of a token

Get historical prices

get

Get historical price points for a token.

Query parameters

tickerstringRequired

The ticker of the share token (Uppercase)

Example: DAKS

Responses

200

Successful operation

application/jsonapplication/xml

tickerstringOptional

ticker of the share

Example: DAKS

monthlyDriftnumberOptional

Monthly change

Example: 0

currencystringOptional

Currency of the price

Example: CHF

400

Not found

get

/prices

HTTPcURLJavaScriptPython

GET /prices?ticker=text HTTP/1.1
Host: ext.aktionariat.com
Accept: */*

{
  "points": [
    {
      "v": 13.933,
      "t": 1678786871000
    }
  ],
  "ticker": "DAKS",
  "monthlyDrift": 0,
  "currency": "CHF"
}