Ratios by period

Reference example

# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
  --url https://api.aisa.one/apis/v1/fiscal-ai/ratios/series \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "cik": "example"
}'

curl --request POST \
  --url https://api.aisa.one/apis/v1/fiscal-ai/ratios/series \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cik": "example"
}
'

import requests

url = "https://api.aisa.one/apis/v1/fiscal-ai/ratios/series"

payload = { "cik": "example" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({cik: 'example'})
};

fetch('https://api.aisa.one/apis/v1/fiscal-ai/ratios/series', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/fiscal-ai/ratios/series",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cik' => 'example'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/fiscal-ai/ratios/series"

	payload := strings.NewReader("{\n  \"cik\": \"example\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/fiscal-ai/ratios/series")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cik\": \"example\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/fiscal-ai/ratios/series")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cik\": \"example\"\n}"

response = http.request(request)
puts response.read_body

POST

https://api.aisa.one

apis

fiscal-ai

ratios

series

Reference example

# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
  --url https://api.aisa.one/apis/v1/fiscal-ai/ratios/series \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "cik": "example"
}'

curl --request POST \
  --url https://api.aisa.one/apis/v1/fiscal-ai/ratios/series \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cik": "example"
}
'

import requests

url = "https://api.aisa.one/apis/v1/fiscal-ai/ratios/series"

payload = { "cik": "example" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({cik: 'example'})
};

fetch('https://api.aisa.one/apis/v1/fiscal-ai/ratios/series', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/fiscal-ai/ratios/series",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cik' => 'example'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/fiscal-ai/ratios/series"

	payload := strings.NewReader("{\n  \"cik\": \"example\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/fiscal-ai/ratios/series")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cik\": \"example\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/fiscal-ai/ratios/series")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cik\": \"example\"\n}"

response = http.request(request)
puts response.read_body

Request contract

Method and path: POST /apis/v1/fiscal-ai/ratios/series
Availability: enabled
Request URL template: https://api.aisa.one/apis/v1/fiscal-ai/ratios/series
Runtime facts: cc435b4c038069b368d2f04fa474db4f4a404dd6c83d32875132ed15f851e166

Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

{
  "operationId": "fiscal-ai.ratios.series",
  "method": "POST",
  "path": "/apis/v1/fiscal-ai/ratios/series",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "examples": {
          "default": {
            "value": {
              "cik": "example"
            }
          },
          "minimal": {
            "value": {
              "cik": "example"
            }
          }
        },
        "schema": {
          "additionalProperties": true,
          "allOf": [
            {
              "anyOf": [
                {
                  "properties": {
                    "cik": {}
                  },
                  "required": [
                    "cik"
                  ]
                },
                {
                  "properties": {
                    "companyKey": {}
                  },
                  "required": [
                    "companyKey"
                  ]
                },
                {
                  "properties": {
                    "cusip": {}
                  },
                  "required": [
                    "cusip"
                  ]
                },
                {
                  "properties": {
                    "figi": {}
                  },
                  "required": [
                    "figi"
                  ]
                },
                {
                  "properties": {
                    "fscl": {}
                  },
                  "required": [
                    "fscl"
                  ]
                },
                {
                  "properties": {
                    "isin": {}
                  },
                  "required": [
                    "isin"
                  ]
                },
                {
                  "properties": {
                    "ticker": {}
                  },
                  "required": [
                    "ticker"
                  ]
                }
              ]
            }
          ],
          "properties": {
            "cik": {
              "type": "string"
            },
            "companyKey": {
              "type": "string"
            },
            "cusip": {
              "type": "string"
            },
            "figi": {
              "type": "string"
            },
            "fscl": {
              "type": "string"
            },
            "isin": {
              "type": "string"
            },
            "ticker": {
              "type": "string"
            }
          },
          "type": "object"
        }
      }
    },
    "required": true
  },
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "cost_contract": "response_units",
    "customer_multiplier": 1.0,
    "customer_pricing": "provider_cost_multiplier",
    "default_request_estimate_usd": 0.0015,
    "estimate_source": "profile_seed",
    "evidence_source": "response_body",
    "unit": "provider_credit",
    "unit_rate_usd": 0.0001
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}

Cost and request rules

Usage-based billing; Default request estimate: $0.0015 USD (not a fixed price). Declared unit rate: $0.0001 USD per provider_credit. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

Default request reference estimate (USD): 0.0015
Declared unit rate (USD): 0.0001
Billing unit: provider_credit
Cost contract: response_units
Published reference multiplier: 1.0
Settlement evidence source: response_body

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

cik

string

required

companyKey

string

cusip

string

figi

string

fscl

string

isin

string

ticker

string

Response

Successful response. The payload schema has not been reviewed yet.

Overview

Browse by category

Ratios by period

Request contract

Cost and request rules

Authorizations

Body

Response

​Request contract

​Cost and request rules

Authorizations

Body

Response

Request contract

Cost and request rules