GET
/
search
/
companies
/
bankruptcies
/
se
curl --request GET \
  --url https://api.tic.io/search/companies/bankruptcies/se \
  --header 'x-api-key: <api-key>'
{
  "facet_counts": [
    {
      "counts": [
        {
          "count": 123,
          "highlighted": "<string>",
          "value": "<string>"
        }
      ],
      "field_name": "<string>",
      "sampled": true,
      "stats": {
        "total_values": 123
      },
      "localizedFieldName": "<string>"
    }
  ],
  "found": 123,
  "hits": [
    {
      "document": {
        "id": "<string>",
        "companyId": 123,
        "registrationNumber": "<string>",
        "legalEntityType": "<string>",
        "localCompanyCode": "<string>",
        "elfCode": "<string>",
        "registrationDate": 123,
        "mostRecentPurpose": "<string>",
        "companyName": "<string>",
        "bankruptcyStatusCode": "<string>",
        "bankruptcyStatusDescriptionSv": "<string>",
        "bankruptcyStatusDescriptionEn": "<string>",
        "sniCodes": [
          {
            "sni_2007Code": "<string>",
            "sni_2007Name": "<string>",
            "rank": 123
          }
        ],
        "courtCase": "<string>",
        "courtName": "<string>",
        "courtCode": "<string>",
        "courtEmail": "<string>",
        "initiatedDate": 123,
        "initiatedBy": "<string>",
        "terminatedDate": 123,
        "repealedDate": 123,
        "hasTrustee": true,
        "trusteeName": "<string>",
        "trusteeCO": "<string>",
        "trusteeAddressStreet": "<string>",
        "trusteeAddressPostalCode": "<string>",
        "trusteeAdddressCity": "<string>",
        "registeredOfficeMunicipality": "<string>",
        "registeredOfficeMunicipalityCode": "<string>",
        "registeredOfficeCounty": "<string>",
        "registeredOfficeCountyCode": "<string>",
        "mostRecentRegisteredAddress": {
          "co": "<string>",
          "streetAddress": "<string>",
          "postalCode": "<string>",
          "city": "<string>",
          "countryCodeAlpha3": "<string>",
          "location": [
            123
          ],
          "firstSeenAt": 123
        },
        "mostRecentFinancialSummary": {
          "periodStart": 123,
          "periodEnd": 123,
          "rs_NetSalesK": 123,
          "rs_OtherOperatingIncomeK": 123,
          "rs_OperatingProfitOrLossK": 123,
          "rs_SumFinancialItemsK": 123,
          "rs_ProfitAfterFinancialItemsK": 123,
          "bs_TotalAssetsK": 123,
          "fn_NumberOfEmployees": 123,
          "km_OperatingMargin": 123,
          "km_NetProfitMargin": 123,
          "km_EquityAssetsRatio": 123,
          "km_GrossMargin": 123,
          "isAudited": true,
          "software": "<string>"
        },
        "applicationIfAny": "<string>",
        "isPublicSectorVendor": true,
        "approxInvoicedToPublicSector": [
          {
            "year": 123,
            "approxInvoiced": 123
          }
        ],
        "lastUpdated": 123
      },
      "geo_distance_meters": "<any>",
      "highlight": "<any>",
      "highlights": [
        {
          "field": "<string>",
          "matched_tokens": [
            "<string>"
          ],
          "snippet": "<string>"
        }
      ],
      "text_match": 123,
      "text_match_info": {
        "best_field_score": "<string>",
        "best_field_weight": 123,
        "fields_matched": 123,
        "num_tokens_dropped": 123,
        "score": "<string>",
        "tokens_matched": 123,
        "typo_prefix_score": 123
      }
    }
  ],
  "grouped_hits": {
    "group_key": [
      "<string>"
    ],
    "hits": [
      {
        "document": {
          "id": "<string>",
          "companyId": 123,
          "registrationNumber": "<string>",
          "legalEntityType": "<string>",
          "localCompanyCode": "<string>",
          "elfCode": "<string>",
          "registrationDate": 123,
          "mostRecentPurpose": "<string>",
          "companyName": "<string>",
          "bankruptcyStatusCode": "<string>",
          "bankruptcyStatusDescriptionSv": "<string>",
          "bankruptcyStatusDescriptionEn": "<string>",
          "sniCodes": [
            {
              "sni_2007Code": "<string>",
              "sni_2007Name": "<string>",
              "rank": 123
            }
          ],
          "courtCase": "<string>",
          "courtName": "<string>",
          "courtCode": "<string>",
          "courtEmail": "<string>",
          "initiatedDate": 123,
          "initiatedBy": "<string>",
          "terminatedDate": 123,
          "repealedDate": 123,
          "hasTrustee": true,
          "trusteeName": "<string>",
          "trusteeCO": "<string>",
          "trusteeAddressStreet": "<string>",
          "trusteeAddressPostalCode": "<string>",
          "trusteeAdddressCity": "<string>",
          "registeredOfficeMunicipality": "<string>",
          "registeredOfficeMunicipalityCode": "<string>",
          "registeredOfficeCounty": "<string>",
          "registeredOfficeCountyCode": "<string>",
          "mostRecentRegisteredAddress": {
            "co": "<string>",
            "streetAddress": "<string>",
            "postalCode": "<string>",
            "city": "<string>",
            "countryCodeAlpha3": "<string>",
            "location": [
              123
            ],
            "firstSeenAt": 123
          },
          "mostRecentFinancialSummary": {
            "periodStart": 123,
            "periodEnd": 123,
            "rs_NetSalesK": 123,
            "rs_OtherOperatingIncomeK": 123,
            "rs_OperatingProfitOrLossK": 123,
            "rs_SumFinancialItemsK": 123,
            "rs_ProfitAfterFinancialItemsK": 123,
            "bs_TotalAssetsK": 123,
            "fn_NumberOfEmployees": 123,
            "km_OperatingMargin": 123,
            "km_NetProfitMargin": 123,
            "km_EquityAssetsRatio": 123,
            "km_GrossMargin": 123,
            "isAudited": true,
            "software": "<string>"
          },
          "applicationIfAny": "<string>",
          "isPublicSectorVendor": true,
          "approxInvoicedToPublicSector": [
            {
              "year": 123,
              "approxInvoiced": 123
            }
          ],
          "lastUpdated": 123
        },
        "geo_distance_meters": "<any>",
        "highlight": "<any>",
        "highlights": [
          {
            "field": "<string>",
            "matched_tokens": [
              "<string>"
            ],
            "snippet": "<string>"
          }
        ],
        "text_match": 123,
        "text_match_info": {
          "best_field_score": "<string>",
          "best_field_weight": 123,
          "fields_matched": 123,
          "num_tokens_dropped": 123,
          "score": "<string>",
          "tokens_matched": 123,
          "typo_prefix_score": 123
        }
      }
    ]
  },
  "out_of": 123,
  "page": 123,
  "request_params": {
    "collection_name": "<string>",
    "first_q": "<string>",
    "per_page": 123,
    "q": "<string>"
  },
  "search_cutoff": true,
  "search_time_ms": 123
}

Authorizations

x-api-key
string
header
required

Query Parameters

q
string
required

The query string use * for all

Minimum length: 1
query_by
string
required

Query by field, for supported fields see documentation

filter_by
string

Filter by, for supported fields see documentation

sort_by
string

Sort by, for supported fields see documentation

view
string

Set to html if you want to render the search result to webpage

Response

200 - application/json
The search response
facet_counts
object[] | null
found
integer
hits
object[] | null
grouped_hits
object
out_of
integer
page
integer
request_params
object
search_cutoff
boolean | null
search_time_ms
integer