### Install Mintlify CLI (npm/yarn)
Source: https://docs.tic.io/development
Installs the Mintlify CLI globally using either npm or yarn. Ensure Node.js version 18.10.0 or higher is installed.
```bash
npm i -g mintlify
```
```bash
yarn global add mintlify
```
--------------------------------
### Start Local Mintlify Development Server
Source: https://docs.tic.io/development
Starts the local development server for Mintlify. Navigate to your docs directory (containing mint.json) and run this command. The website will be available at http://localhost:3000 by default.
```bash
mintlify dev
```
--------------------------------
### Install Orb Library with npm
Source: https://docs.tic.io/technology/graph-visualization
This command installs the Orb library, a JavaScript library for graph visualization, using npm. It is a prerequisite for using Orb in a web project.
```shell
npm install @memgraph/orb
```
--------------------------------
### Map Integration Example
Source: https://docs.tic.io/maps/introduction
This example demonstrates how to integrate Tic.io's vector maps into a webpage using MapLibre GL JS. It includes including the necessary library files and basic map initialization.
```APIDOC
## Map Integration with MapLibre GL JS
### Description
This section provides a practical example of how to embed and initialize a vector map on a webpage using the MapLibre GL JS library. It covers including the required CSS and JavaScript files, and setting up the map container and initial properties.
### Method
N/A (Client-side integration)
### Endpoint
N/A (Client-side integration)
### Parameters
None (Client-side configuration)
### Request Example
```html
```
### Response
N/A (Client-side rendering)
```
--------------------------------
### Example Certificate Log Entries
Source: https://docs.tic.io/technology/domain-and-social-media-monitoring
Demonstrates the structure of example certificate log entries obtained from certificate transparency logs. These entries contain details about issued certificates, including issuer information, common name, validity periods, and timestamps.
```json
[
{
"issuer_ca_id": 183267,
"issuer_name": "C=US, O=Let's Encrypt, CN=R3",
"common_name": "aimn.eng.kb.kundo.se",
"name_value": "aimn.eng.kb.kundo.se",
"id": 4621048740,
"entry_timestamp": "2021-05-31T09:49:11.019",
"not_before": "2021-05-31T08:49:10",
"not_after": "2021-08-29T08:49:10",
"serial_number": "03960b69bbef9f16051fc886795165302746",
"result_count": 1
},
{
"issuer_ca_id": 183267,
"issuer_name": "C=US, O=Let's Encrypt, CN=R3",
"common_name": "k2a.kb.kundo.se",
"name_value": "k2a.kb.kundo.se",
"id": 4616950227,
"entry_timestamp": "2021-05-30T16:12:00.294",
"not_before": "2021-05-30T15:12:00",
"not_after": "2021-08-28T15:12:00",
"serial_number": "04fe8b238d0ab13e6f63e67e40949ca528af",
"result_count": 2
}
]
```
--------------------------------
### Get Reseller Customers OpenAPI Specification
Source: https://docs.tic.io/api-reseller/reseller-customers
This OpenAPI specification defines the GET endpoint for retrieving reseller customers. It requires an API key with an active reseller account and returns a list of customer objects.
```yaml
openapi: 3.0.4
info:
title: TIC API
description: ''
version: v1
servers:
- url: https://api.tic.io/
security:
- ApiKey: []
tags:
- name: BolagsverketStatistics
- name: Companies
- name: Companies_SE_
- name: DocumentDelivery
- name: EuropeanCommission
- name: FinancialDocuments
- name: Finansinspektionen
- name: Free
- name: ICA
- name: ICAStatistics
- name: Lists
- name: Media
- name: Persons
- name: Persons_SE_
- name: Properties_SE_
- name: PTSPortings
- name: Reseller
- name: SearchBankruptciesReports
- name: SearchCompanies
- name: SearchCompaniesReports
- name: SearchCompanyWorkplaces
- name: SearchPerson
- name: SearchProperties_SE_
- name: SearchVehicles
- name: Teams
- name: User
- name: Vehicles_SE_
- name: WatchLists
paths:
/reseller/customers:
get:
tags:
- Reseller
summary: Get customers
description: Get the resellers customers
operationId: ResellerCustomers
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Ormeo_WebAPI_Models_Reseller_ResellerCustomer_Dto'
components:
schemas:
Ormeo_WebAPI_Models_Reseller_ResellerCustomer_Dto:
type: object
properties:
teamId:
type: integer
format: int32
teamGuid:
type: string
format: uuid
teamName:
type: string
nullable: true
teamDescription:
type: string
nullable: true
teamEmail:
type: string
nullable: true
additionalProperties: false
securitySchemes:
ApiKey:
type: apiKey
name: x-api-key
in: header
```
--------------------------------
### GET /reseller/customers
Source: https://docs.tic.io/api-reseller/reseller-customers
Retrieves a list of customers associated with the reseller account. Requires an API key with reseller privileges.
```APIDOC
## GET /reseller/customers
### Description
Get the resellers customers. Allows you to get a list of customers associated with your reseller account. If you an API key that has an active reseller account with us to use this endpoint.
### Method
GET
### Endpoint
/reseller/customers
### Parameters
#### Query Parameters
(No query parameters defined)
#### Request Body
(No request body defined)
### Request Example
(No request example provided)
### Response
#### Success Response (200)
- **teamId** (integer) - The ID of the team.
- **teamGuid** (string) - The GUID of the team.
- **teamName** (string) - The name of the team (nullable).
- **teamDescription** (string) - The description of the team (nullable).
- **teamEmail** (string) - The email address of the team (nullable).
#### Response Example
```json
[
{
"teamId": 123,
"teamGuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"teamName": "Example Team",
"teamDescription": "This is an example team.",
"teamEmail": "team@example.com"
}
]
```
```
--------------------------------
### Run Mintlify on Custom Port
Source: https://docs.tic.io/development
Starts the Mintlify development server on a custom port. Use the --port flag followed by the desired port number to avoid conflicts.
```bash
mintlify dev --port 3333
```
--------------------------------
### Troubleshoot Windows 'No such file or directory' Error
Source: https://docs.tic.io/development
Resolves the 'No such file or directory' error on Windows by manually removing the mint folder from the .mintlify directory and re-cloning the mint repository via Git Bash.
```bash
Go to the `C:/Users/Username/.mintlify/` directory and remove the `mint` folder. Then Open the Git Bash in this location and run `git clone https://github.com/mintlify/mint.git`.
Repeat step 3.
```
--------------------------------
### GET /datasets/companies/{companyId}/financial-report-summaries/{financialReportSummaryId}/files
Source: https://docs.tic.io/api-core/companies/financial-report-files
Gets all files available for a financial report summary. This endpoint retrieves all present available files in the financial report.
```APIDOC
## GET /datasets/companies/{companyId}/financial-report-summaries/{financialReportSummaryId}/files
### Description
Gets all files available for a financial report summary. This endpoint retrieves all present available files in the financial report.
### Method
GET
### Endpoint
/datasets/companies/{companyId}/financial-report-summaries/{financialReportSummaryId}/files
### Parameters
#### Path Parameters
- **companyId** (integer) - Required - The company id
- **financialReportSummaryId** (integer) - Required - The financial report summary id
### Request Example
```json
{
"example": "No request body needed for this GET request."
}
```
### Response
#### Success Response (200)
- **companyFinancialReportFileId** (integer) - The ID of the financial report file.
- **reportFileType** (string) - The type of the report file (e.g., xbrl, tiff, originalPDFImage).
- **firstSeenAtUtc** (string) - The date and time when the file was first seen (ISO 8601 format).
- **lastUpdatedAtUtc** (string) - The date and time when the file was last updated (ISO 8601 format).
#### Response Example
```json
[
{
"companyFinancialReportFileId": 12345,
"reportFileType": "xbrl",
"firstSeenAtUtc": "2023-01-15T10:00:00Z",
"lastUpdatedAtUtc": "2023-01-15T10:00:00Z"
},
{
"companyFinancialReportFileId": 67890,
"reportFileType": "originalPDFImage",
"firstSeenAtUtc": "2023-01-15T10:05:00Z",
"lastUpdatedAtUtc": "2023-01-15T10:05:00Z"
}
]
```
#### Error Response (404)
- **description**: Not Found
```
--------------------------------
### Example Financial Document Response (JSON)
Source: https://docs.tic.io/api-core/financial-documents/financial-documents-se
Provides an example JSON response for retrieving financial document metadata. It includes details like the document reference, case number, registration date, and a list of available file types and their corresponding URLs.
```json
{
"financialDocumentReference": "2_0",
"isElectronic": true,
"caseNumber": 9000102,
"caseYear": 2024,
"caseRegistrationDate": "2024-01-01T16:05:16",
"availableFiles": [
{
"fileType": "reportPDF",
"url": "https://api.tic.io/financial-documents/se/2_0/pdf"
},
{
"fileType": "reportXBRL",
"url": "https://api.tic.io/financial-documents/se/2_0/xbrl"
},
{
"fileType": "errorXHTML",
"url": "https://api.tic.io/financial-documents/se/2_0/error"
},
{
"fileType": "reportXHTML",
"url": "https://api.tic.io/financial-documents/se/2_0/ixbrl"
},
{
"fileType": "metadata",
"url": "https://api.tic.io/financial-documents/se/2_0/metadata"
}
]
}
```
--------------------------------
### Get Company Ownerships via OpenAPI
Source: https://docs.tic.io/api-core/companies/ownerships
This OpenAPI definition describes a GET endpoint to retrieve companies in which a specified company has ownership. It requires a companyId as a path parameter and returns an array of CompanySummary objects.
```yaml
openapi: 3.0.4
info:
title: TIC API
description: ''
version: v1
servers:
- url: https://api.tic.io/
security:
- ApiKey: []
tags:
- name: BolagsverketStatistics
- name: Companies
- name: Companies_SE_
- name: DocumentDelivery
- name: EuropeanCommission
- name: FinancialDocuments
- name: Finansinspektionen
- name: Free
- name: ICA
- name: ICAStatistics
- name: Lists
- name: Media
- name: Persons
- name: Persons_SE_
- name: Properties_SE_
- name: PTSPortings
- name: Reseller
- name: SearchBankruptciesReports
- name: SearchCompanies
- name: SearchCompaniesReports
- name: SearchCompanyWorkplaces
- name: SearchPerson
- name: SearchProperties_SE_
- name: SearchVehicles
- name: Teams
- name: User
- name: Vehicles_SE_
- name: WatchLists
paths:
/datasets/companies/{companyId}/has-ownership-in:
get:
tags:
- Companies
summary: Ownerships
description: Get companies that the company has ownership in
operationId: CompanyHasOwnerships
parameters:
- name: companyId
in: path
description: The company id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/Ormeo_Library_Entities_DTO_SE_CompanySummary
components:
schemas:
Ormeo_Library_Entities_DTO_SE_CompanySummary:
type: object
properties:
companyId:
type: integer
format: int32
companyRegistrationNumber:
type: string
nullable: true
registrationDate:
type: string
format: date-time
nullable: true
mostRecentLegalName:
type: string
nullable: true
mostRecentPurpose:
type: string
nullable: true
mostRecentCompanyStatusType:
type: integer
format: int32
nullable: true
companyRepresentativeBornYear:
type: integer
format: int32
nullable: true
industry:
type: string
nullable: true
year1_AnnualReportPeriod:
type: integer
format: int32
nullable: true
year1_NetSales:
type: integer
format: int32
nullable: true
year1_OperatingProfit:
type: integer
format: int32
nullable: true
year1_NetSalesChange:
type: number
format: double
nullable: true
year1_GrossMargin:
type: number
format: double
nullable: true
year1_OperatingMargin:
type: number
format: double
nullable: true
year1_NetProfitMargin:
type: number
format: double
nullable: true
year1_NumberOfEmployees:
type: integer
format: int32
nullable: true
year2_AnnualReportPeriod:
type: integer
format: int32
nullable: true
year2_NetSales:
type: integer
format: int32
nullable: true
year2_OperatingProfit:
type: integer
format: int32
nullable: true
year2_NetSalesChange:
type: number
format: double
nullable: true
year2_GrossMargin:
type: number
format: double
nullable: true
year2_OperatingMargin:
type: number
format: double
nullable: true
year2_NetProfitMargin:
type: number
format: double
nullable: true
year2_NumberOfEmployees:
type: integer
format: int32
nullable: true
year3_AnnualReportPeriod:
type: integer
format: int32
nullable: true
year3_NetSales:
type: integer
format: int32
nullable: true
year3_OperatingProfit:
type: integer
format: int32
nullable: true
year3_NetSalesChange:
type: number
format: double
nullable: true
year3_GrossMargin:
type: number
format: double
nullable: true
year3_OperatingMargin:
type: number
format: double
nullable: true
year3_NetProfitMargin:
type: number
format: double
nullable: true
year3_NumberOfEmployees:
type: integer
format: int32
nullable: true
year4_AnnualReportPeriod:
type: integer
format: int32
nullable: true
```
--------------------------------
### Folder-Based Navigation Configuration (JSON)
Source: https://docs.tic.io/essentials/navigation
Shows how to configure navigation to include pages located within specific folders. The path in `mint.json` should reflect the folder structure on the filesystem.
```json
"navigation": [
{
"group": "Group Name",
"pages": ["your-folder/your-page"]
}
]
```
--------------------------------
### Get Company Names - OpenAPI Specification
Source: https://docs.tic.io/api-core/companies/names
This OpenAPI 3.0.4 specification defines the GET endpoint for retrieving company names. It includes request parameters, response schemas, and security definitions.
```yaml
openapi: 3.0.4
info:
title: TIC API
description: ''
version: v1
servers:
- url: https://api.tic.io/
security:
- ApiKey: []
tags:
- name: BolagsverketStatistics
- name: Companies
- name: Companies_SE_
- name: DocumentDelivery
- name: EuropeanCommission
- name: FinancialDocuments
- name: Finansinspektionen
- name: Free
- name: ICA
- name: ICAStatistics
- name: Lists
- name: Media
- name: Persons
- name: Persons_SE_
- name: Properties_SE_
- name: PTSPortings
- name: Reseller
- name: SearchBankruptciesReports
- name: SearchCompanies
- name: SearchCompaniesReports
- name: SearchCompanyWorkplaces
- name: SearchPerson
- name: SearchProperties_SE_
- name: SearchVehicles
- name: Teams
- name: User
- name: Vehicles_SE_
- name: WatchLists
paths:
/datasets/companies/{companyId}/names:
get:
tags:
- Companies
summary: Names
description: Gets the names of the company
operationId: CompanyNames
parameters:
- name: companyId
in: path
description: The company id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/Ormeo_WebAPI_Models_Datasets_Company_CompanyName_Dto
components:
schemas:
Ormeo_WebAPI_Models_Datasets_Company_CompanyName_Dto:
type: object
properties:
companyNamingType:
$ref: '#/components/schemas/Ormeo_Library_Entities_CompanyNamingType'
companyNamingTypeDescription:
type: string
nullable: true
readOnly: true
nameOrIdentifier:
type: string
nullable: true
firstSeenAtUtc:
type: string
format: date-time
nullable: true
companyNameDecidedAt:
type: string
format: date-time
nullable: true
specialPurpose:
type: string
nullable: true
additionalProperties: false
Ormeo_Library_Entities_CompanyNamingType:
enum:
- legalName
- commonName
- tradingName
- particularName
- foreignLanguageName
- other
- legalNameSuggested
- commonNameSuggested
- tradingNameSuggested
- particularNameSuggested
- foreignLanguageNameSuggested
type: string
securitySchemes:
ApiKey:
type: apiKey
name: x-api-key
in: header
```
--------------------------------
### POST /reseller/customers
Source: https://docs.tic.io/api-reseller/reseller-create-customers
Creates a new customer for a reseller. Use `isTest=true` to avoid creating actual accounts during testing.
```APIDOC
## POST /reseller/customers
### Description
Creates a new customer for a reseller.
### Method
POST
### Endpoint
/reseller/customers
### Query Parameters
- **isTest** (boolean) - Optional - Set flag to true if you don't want to create the actual customer. Default: false
### Request Body
- **domainOrCompanyName** (string) - Optional - The domain or company name of the customer.
- **emailAddress** (string) - Optional - The email address of the customer.
- **externalReference** (string) - Optional - An external reference identifier for the customer.
### Request Example
```json
{
"domainOrCompanyName": "example.com",
"emailAddress": "customer@example.com",
"externalReference": "ref123"
}
```
### Response
#### Success Response (200)
- **teamId** (integer) - The unique identifier for the created team.
- **teamGuid** (string) - The globally unique identifier for the created team.
- **teamName** (string) - The name of the team.
- **teamDescription** (string) - A description for the team.
- **teamEmail** (string) - The email address associated with the team.
- **apiKey** (string) - The API key for the newly created customer.
#### Response Example
```json
{
"teamId": 12345,
"teamGuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"teamName": "Example Company",
"teamDescription": "Customer account for example.com",
"teamEmail": "customer@example.com",
"apiKey": "sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
```
```
--------------------------------
### GET /free/health
Source: https://docs.tic.io/api-free/health
Gets the health status for the API, search, and other services. It does not require authentication. If an API key is provided, it also returns rate limit information and details about upcoming service windows.
```APIDOC
## GET /free/health
### Description
Gets health status for our API, search and other services. It doesn't require any token or authentication. If you provide your authentication with your x-api-key or included in the querystring we will respond back also with the current limits for the API key equals the header data you receive for X-RateLimit-*. Response also includes information about any upcoming service windows.
### Method
GET
### Endpoint
https://api.tic.io/free/health
### Parameters
#### Query Parameters
- **x-api-key** (string) - Optional - Your API key for authentication and rate limit information.
### Request Example
```json
{
"example": "No request body needed for GET request"
}
```
### Response
#### Success Response (200)
- **ok** (boolean) - Indicates if the service is operational.
- **upcomingServiceWindows** (array) - A list of upcoming service windows, if any.
- **startDateUtc** (string) - The start date and time of the service window in UTC.
- **endDateUtc** (string) - The end date and time of the service window in UTC.
- **notes** (string) - Additional notes about the service window.
- **lastUpdatedAtUtc** (string) - The last time the service window information was updated in UTC.
- **limits** (object) - Rate limit information for the API key.
- **rateLimitReset** (integer) - The timestamp when the rate limit will reset.
- **rateLimit** (integer) - The total number of requests allowed within the rate limit period.
- **rateLimitRemaining** (integer) - The number of requests remaining within the current rate limit period.
- **rateLimitMinute** (integer) - The number of requests allowed per minute.
- **rateLimitIP** (integer) - The number of requests allowed per IP address.
#### Response Example
```json
{
"ok": true,
"upcomingServiceWindows": [
{
"startDateUtc": "2025-02-02T06:00:00",
"endDateUtc": "2025-02-02T06:05:00",
"notes": "Just for demonstration",
"lastUpdatedAtUtc": "2025-02-01T08:52:43"
}
],
"limits": {
"rateLimitReset": 2435948,
"rateLimit": 3000,
"rateLimitRemaining": 2965,
"rateLimitMinute": 960,
"rateLimitIP": 200
}
}
```
```
--------------------------------
### Website Configuration and Financial Data
Source: https://docs.tic.io/api-industry/icastatistics/store
This section details the structure for website configuration, including financial cost caching and highlight settings.
```APIDOC
## Website Configuration and Financial Data
### Description
This section describes the schema for website configuration, including details about financial cost caching and highlight properties.
### Method
N/A (Schema Definition)
### Endpoint
N/A (Schema Definition)
### Parameters
#### Path Parameters
None
#### Query Parameters
None
#### Request Body
##### `websites_tic_io_websites_Website` (Object)
- `periodLength` (string, nullable) - The length of the period for the website.
- `highlight` (boolean) - Indicates if the website is highlighted.
- `highlightLabel` (string, nullable) - A label for the highlighted website.
##### `Ormeo_Library_ICA_Cache_ICAStoreDetailFinancialCostCache` (Object)
- `label` (string, nullable) - The label for the financial cost.
- `amount` (array of integers, nullable) - The amount associated with the financial cost.
### Request Example
```json
{
"websites_tic_io_websites_Website": {
"periodLength": "monthly",
"highlight": true,
"highlightLabel": "Featured"
},
"Ormeo_Library_ICA_Cache_ICAStoreDetailFinancialCostCache": {
"label": "Subscription Fee",
"amount": [100, 200, 300]
}
}
```
### Response
#### Success Response (200)
Schema definition, no specific success response data.
#### Response Example
N/A (Schema Definition)
```
--------------------------------
### Get Company Purpose - OpenAPI Specification
Source: https://docs.tic.io/api-core/companies/purposes
This OpenAPI 3.0.4 specification defines the GET endpoint for retrieving the purposes of a company. It requires a company ID as a path parameter and returns an array of company purpose details.
```yaml
openapi: 3.0.4
info:
title: TIC API
description: ''
version: v1
servers:
- url: https://api.tic.io/
security:
- ApiKey: []
tags:
- name: BolagsverketStatistics
- name: Companies
- name: Companies_SE_
- name: DocumentDelivery
- name: EuropeanCommission
- name: FinancialDocuments
- name: Finansinspektionen
- name: Free
- name: ICA
- name: ICAStatistics
- name: Lists
- name: Media
- name: Persons
- name: Persons_SE_
- name: Properties_SE_
- name: PTSPortings
- name: Reseller
- name: SearchBankruptciesReports
- name: SearchCompanies
- name: SearchCompaniesReports
- name: SearchCompanyWorkplaces
- name: SearchPerson
- name: SearchProperties_SE_
- name: SearchVehicles
- name: Teams
- name: User
- name: Vehicles_SE_
- name: WatchLists
paths:
/datasets/companies/{companyId}/purpose:
get:
tags:
- Companies
summary: Purposes
description: Gets the purposes of the company
operationId: CompanyPurpose
parameters:
- name: companyId
in: path
description: The company id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/Ormeo_WebAPI_Models_Datasets_Company_CompanyPurpose_Dto
components:
schemas:
Ormeo_WebAPI_Models_Datasets_Company_CompanyPurpose_Dto:
type: object
properties:
companyPurposeId:
type: integer
format: int32
purpose:
type: string
nullable: true
firstSeenAtUtc:
type: string
format: date-time
nullable: true
lastUpdatedAtUtc:
type: string
format: date-time
additionalProperties: false
securitySchemes:
ApiKey:
type: apiKey
name: x-api-key
in: header
```
--------------------------------
### Client Generation with OpenAPI Generator
Source: https://docs.tic.io/generate-client
Instructions and resources for generating client code for the Tic.io API using the OpenAPI Generator.
```APIDOC
## Client Generation
### Description
Our API adheres to the OpenAPI specification 3.0.1. You can leverage the [OpenAPI Generator](https://openapi-generator.tech/) to automatically generate client code for various programming languages, simplifying API integration.
### Supported Languages
The OpenAPI Generator supports a wide range of languages, including but not limited to:
* ada
* android
* apex
* bash
* c
* clojure
* cpp- qt- client
* cpp- restsdk
* cpp- tiny (beta)
* cpp- tizen
* cpp- ue4 (beta)
* crystal (beta)
* csharp
* dart
* dart- dio
* eiffel
* elixir
* elm
* erlang- client
* erlang- proper
* go
* groovy
* haskell- http- client
* java
* java- helidon- client (beta)
* java- micronaut- client (beta)
* javascript
* javascript- apollo- deprecated (deprecated)
* javascript- closure- angular (beta)
* javascript- flowtyped
* jaxrs- cxf- client
* jetbrains- http- client (experimental)
* jmeter
* julia- client (beta)
* k6 (beta)
* kotlin
* lua (beta)
* n4js (beta)
* nim (beta)
* objc
* ocaml
* perl
* php
* php- dt (beta)
* php- nextgen (beta)
* powershell (beta)
* python
* python- pydantic- v1
* r
* ruby
* rust
* scala- akka
* scala- gatling
* scala- pekko
* scala- sttp
* scala- sttp4 (beta)
* scalaz
* swift- combine
* swift5
* typescript (experimental)
* typescript- angular
* typescript- aurelia
* typescript- axios
* typescript- fetch
* typescript- inversify
* typescript- jquery
* typescript- nestjs (experimental)
* typescript- node
* typescript- redux- query
* typescript- rxjs
* xojo- client
* zapier (beta)
### Usage Example (Conceptual)
```bash
openapi-generator generate -i https://api.tic.io/docs/v1/swagger.json -g -o ./tic-io-client
```
Replace `` with your desired programming language from the list above.
### Further Information
Refer to the [OpenAPI Generator documentation](https://openapi-generator.tech/docs/generators) for detailed instructions and options.
```
--------------------------------
### Example ICA Store Response (JSON)
Source: https://docs.tic.io/api-industry/introduction
This is an example JSON response when fetching ICA store data. It includes pagination information and a list of items, where each item contains store-specific IDs and the crucial `companyId`.
```json
{
"pageSize": 10,
"lastItemId": 10,
"totalItems": 1283,
"items": [
{
"icaStoreId": 1,
"companyId": 2692434,
"icaExternalStoreId": "01441",
"icaStoreOwnerId": 33420
}
```
--------------------------------
### Import and Use MDX Snippet
Source: https://docs.tic.io/essentials/reusable-snippets
Imports a previously defined MDX snippet into a destination file. This allows the content of the snippet to be reused, with variables passed as props. The snippet is imported using its file path.
```mdx
```mdx destination-file.mdx theme={null}
---
title: My title
description: My Description
---
import MySnippet from '/snippets/path/to/my-snippet.mdx';
## Header
Lorem impsum dolor sit amet.
```
```
--------------------------------
### Get Bolagsverket Financial Reports Daily Statistics (OpenAPI)
Source: https://docs.tic.io/api-statistics/bolagsverket/financial-reports-daily
This OpenAPI definition describes the GET endpoint for retrieving daily statistics of registered financial reports at Bolagsverket. It specifies the request parameters, response structure, and authentication method (API Key).
```yaml
openapi: 3.0.4
info:
title: TIC API
description: ''
version: v1
servers:
- url: https://api.tic.io/
security:
- ApiKey: []
tags:
- name: BolagsverketStatistics
- name: Companies
- name: Companies_SE_
- name: DocumentDelivery
- name: EuropeanCommission
- name: FinancialDocuments
- name: Finansinspektionen
- name: Free
- name: ICA
- name: ICAStatistics
- name: Lists
- name: Media
- name: Persons
- name: Persons_SE_
- name: Properties_SE_
- name: PTSPortings
- name: Reseller
- name: SearchBankruptciesReports
- name: SearchCompanies
- name: SearchCompaniesReports
- name: SearchCompanyWorkplaces
- name: SearchPerson
- name: SearchProperties_SE_
- name: SearchVehicles
- name: Teams
- name: User
- name: Vehicles_SE_
- name: WatchLists
paths:
/statistics/se/bolagsverket/financial-reports/daily:
get:
tags:
- BolagsverketStatistics
summary: Bolagsverket financial reports daily statistics
description: Get statistics of registered financial reports per day at Bolagsverket
operationId: BolagsverketStatisticsReportsDaily
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: >-
#/components/schemas/Ormeo_Library_Generators_Statistics_BolagsverketFinancialReportsStatistics
'404':
description: Not Found
components:
schemas:
Ormeo_Library_Generators_Statistics_BolagsverketFinancialReportsStatistics:
type: object
properties:
eReports:
type: array
items:
type: array
items:
type: integer
format: int32
nullable: true
pReports:
type: array
items:
type: array
items:
type: integer
format: int32
nullable: true
softwareEnum:
type: object
additionalProperties:
type: string
nullable: true
nullable: true
softwareUsed:
type: array
items:
type: array
items:
type: integer
format: int32
nullable: true
intelligence:
type: array
items:
type: array
items:
type: number
format: float
nullable: true
softwareYTD:
type: object
additionalProperties:
type: integer
format: int32
nullable: true
additionalProperties: false
securitySchemes:
ApiKey:
type: apiKey
name: x-api-key
in: header
```
--------------------------------
### Markdown Blockquotes
Source: https://docs.tic.io/essentials/markdown
Shows how to create blockquotes in Markdown for quoting text. Examples include single-line and multi-line blockquotes, using the '>' character at the beginning of a line.
```markdown
> Dorothy followed her through many of the beautiful rooms in her castle.
> Dorothy followed her through many of the beautiful rooms in her castle.
>
The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
```
--------------------------------
### Get User Identity Details (OpenAPI)
Source: https://docs.tic.io/api-core/user/me
This OpenAPI specification defines the GET request for the '/user/me' endpoint. It allows retrieval of the calling user's identity details. Authentication is handled via an API key.
```yaml
openapi: 3.0.4
info:
title: TIC API
description: ''
version: v1
servers:
- url: https://api.tic.io/
security:
- ApiKey: []
tags:
- name: BolagsverketStatistics
- name: Companies
- name: Companies_SE_
- name: DocumentDelivery
- name: EuropeanCommission
- name: FinancialDocuments
- name: Finansinspektionen
- name: Free
- name: ICA
- name: ICAStatistics
- name: Lists
- name: Media
- name: Persons
- name: Persons_SE_
- name: Properties_SE_
- name: PTSPortings
- name: Reseller
- name: SearchBankruptciesReports
- name: SearchCompanies
- name: SearchCompaniesReports
- name: SearchCompanyWorkplaces
- name: SearchPerson
- name: SearchProperties_SE_
- name: SearchVehicles
- name: Teams
- name: User
- name: Vehicles_SE_
- name: WatchLists
paths:
/user/me:
get:
tags:
- User
summary: Me
description: Get the identity details representing the calling user
operationId: UserMe
responses:
'200':
description: OK
components:
securitySchemes:
ApiKey:
type: apiKey
name: x-api-key
in: header
```
--------------------------------
### Display Inline Code with Backticks
Source: https://docs.tic.io/essentials/code
Demonstrates how to format inline code using single backticks. This is useful for highlighting short code snippets or commands within text.
```markdown
To denote a `word` or `phrase` as code, enclose it in backticks (`).
```
--------------------------------
### Get Trademark Media (OpenAPI)
Source: https://docs.tic.io/api-core/media/trademark-se-availablemedia
This OpenAPI specification defines the GET endpoint for retrieving available media for a trademark. It requires a trademarkId as a path parameter and returns an array of TrademarkMediaSE_dto objects, each containing fileName and mediaFileFormat.
```yaml
openapi: 3.0.4
info:
title: TIC API
description: ''
version: v1
servers:
- url: https://api.tic.io/
security:
- ApiKey: []
tags:
- name: BolagsverketStatistics
- name: Companies
- name: Companies_SE_
- name: DocumentDelivery
- name: EuropeanCommission
- name: FinancialDocuments
- name: Finansinspektionen
- name: Free
- name: ICA
- name: ICAStatistics
- name: Lists
- name: Media
- name: Persons
- name: Persons_SE_
- name: Properties_SE_
- name: PTSPortings
- name: Reseller
- name: SearchBankruptciesReports
- name: SearchCompanies
- name: SearchCompaniesReports
- name: SearchCompanyWorkplaces
- name: SearchPerson
- name: SearchProperties_SE_
- name: SearchVehicles
- name: Teams
- name: User
- name: Vehicles_SE_
- name: WatchLists
paths:
/media/trademarks/se/{trademarkId}:
get:
tags:
- Media
summary: Get available trademark media
description: Gets available media for trademark
operationId: TrademarkAvailableMediaSE
parameters:
- name: trademarkId
in: path
description: The trademark id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: >-
#/components/schemas/Ormeo_WebAPI_Models_Media_TrademarkMediaSE_dto
components:
schemas:
Ormeo_WebAPI_Models_Media_TrademarkMediaSE_dto:
type: object
properties:
fileName:
type: string
nullable: true
mediaFileFormat:
type: string
nullable: true
additionalProperties: false
securitySchemes:
ApiKey:
type: apiKey
name: x-api-key
in: header
```