GET
/
search
/
companies
/
free
curl --request GET \
  --url https://api.tic.io/search/companies/free \
  --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,
        "iso3166CountryCode": "<string>",
        "registrationNumber": "<string>",
        "legalEntityType": "<string>",
        "localCompanyCode": "<string>",
        "elfCode": "<string>",
        "registrationDate": 123,
        "ceasedDate": 123,
        "isCeased": true,
        "mostRecentPurpose": "<string>",
        "activityStatus": "hasNeverBeenActive",
        "mostRecentRegisteredAddress": {
          "co": "<string>",
          "streetAddress": "<string>",
          "postalCode": "<string>",
          "city": "<string>",
          "countryCodeAlpha3": "<string>",
          "location": [
            123
          ],
          "firstSeenAt": 123
        },
        "mostRecentMailingAddress": {
          "co": "<string>",
          "streetAddress": "<string>",
          "postalCode": "<string>",
          "city": "<string>",
          "countryCodeAlpha3": "<string>",
          "location": [
            123
          ],
          "firstSeenAt": 123
        },
        "mostRecentVisitingAddress": {
          "co": "<string>",
          "streetAddress": "<string>",
          "postalCode": "<string>",
          "city": "<string>",
          "countryCodeAlpha3": "<string>",
          "location": [
            123
          ],
          "firstSeenAt": 123
        },
        "currentWorkplaces": [
          {
            "companyWorkplaceId": 123,
            "workplaceCode": 123,
            "mostRecentName": "<string>",
            "labelAddress": "<string>",
            "location": [
              123
            ]
          }
        ],
        "names": [
          {
            "nameOrIdentifier": "<string>",
            "companyNamingType": "legalName",
            "firstSeenAt": 123
          }
        ],
        "registeredOffices": [
          {
            "municipality": "<string>",
            "municipalityCode": "<string>",
            "county": "<string>",
            "countyCode": "<string>",
            "firstSeenAt": 123
          }
        ],
        "phoneNumbers": [
          {
            "e164PhoneNumber": "<string>",
            "phoneNumberType": "fixedLine",
            "numberPlanServiceType": "<string>",
            "orginalOperator": "<string>",
            "priorOperator": "<string>",
            "currentOperator": "<string>",
            "lastPortingDate": 123
          }
        ],
        "hasPhoneNumbers": true,
        "emailAddresses": [
          {
            "emailAddress": "<string>",
            "emailAddressType": "general"
          }
        ],
        "hasEmailAddresses": true,
        "hyperlinks": [
          {
            "hyperlink": "<string>",
            "hyperlinkType": "homepage"
          }
        ],
        "hasHyperlinks": true,
        "sniCodes": [
          {
            "sni_2007Code": "<string>",
            "sni_2007Name": "<string>",
            "rank": 123
          }
        ],
        "intelligence": [
          {
            "companyIntelligenceType": "createdAsShelfCompany",
            "companyIntelligenceSubType": "<string>",
            "notes": "<string>",
            "score": 123,
            "firstSeenAt": 123,
            "documentUrl": "<string>"
          }
        ],
        "hasIntelligence": true,
        "status": [
          {
            "companyStatusType": "reorganizationOfBusinessCommenced",
            "statusDate": 123,
            "statusDescription": "<string>"
          }
        ],
        "hasStatus": true,
        "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>"
        },
        "hasMostRecentFinancialSummary": true,
        "isRegisteredForVAT": true,
        "isRegisteredForFTax": true,
        "isRegisteredForPayroll": true,
        "registration": [
          {
            "companyRegistrationType": "fTax",
            "companyRegistrationSubType": "<string>",
            "isRegistered": true,
            "registeredFrom": 123,
            "registeredTo": 123,
            "terminationReasonIfAny": "<string>",
            "firstSeenAt": 123
          }
        ],
        "ftaxTerminationReason": "<string>",
        "bankAccounts": [
          {
            "bankAccountType": "bankgiro",
            "accountNumber": "<string>",
            "swift_BIC": "<string>"
          }
        ],
        "hasBankAccounts": true,
        "documents": [
          {
            "companyDocumentId": 123,
            "companyDocumentType": "annualReport",
            "documentDate": 123,
            "documentTitle": "<string>",
            "documentVersion": "<string>",
            "documentValue1": "<string>",
            "documentValue2": "<string>",
            "documentValue3": "<string>",
            "grossPriceIfAny": 123,
            "documentUrl": "<string>"
          }
        ],
        "hasDocuments": true,
        "lastAnnualReportDate": 123,
        "stock": {
          "isin": "<string>",
          "ticker": "<string>",
          "yahooSymbol": "<string>",
          "marketName": "<string>",
          "marketExchangeName": "<string>",
          "marketCountryCodeAlpha3": "<string>",
          "sectorName": "<string>",
          "branchName": "<string>",
          "listingDate": 123,
          "enterpriseValue": 123,
          "enterpriseValueUpdated": 123,
          "stockQuote": 123,
          "stockQuoteUpdated": 123,
          "nextReportDate": 123,
          "nextReportType": "<string>",
          "dividendExDate": 123,
          "dividendsPerYear": 123,
          "dividendAmount": 123,
          "dividendCurrency": "<string>"
        },
        "hasStock": true,
        "lei": {
          "leiCode": "<string>",
          "registrationStatus": "<string>",
          "initialRegistrationDate": 123,
          "nextRenewalDate": 123,
          "managingLOU": "<string>",
          "managingLOULegalName": "<string>"
        },
        "hasLEI": true,
        "salesToPublicActors": [
          {
            "actorName": "<string>",
            "actorType": "<string>",
            "actorCode": "<string>",
            "sales": [
              {
                "year": 123,
                "approxInvoicedK": 123
              }
            ]
          }
        ],
        "hasSalesToPublicActors": true,
        "ecParticipant": {
          "pic": "<string>",
          "validationStatus": "<string>",
          "numberOfProjects": 123,
          "workProgrammesData": "<any>",
          "lastUpdated": 123
        },
        "hasECParticipant": true,
        "franchisesOrLicences": [
          {
            "linkedToName": "<string>",
            "linkedToCompanyId": 123,
            "actingUnderName": "<string>",
            "description": "<string>",
            "companyFranchiseOrLicenceType": "franchise",
            "data": [
              "<any>"
            ]
          }
        ],
        "hasFranchisesOrLicences": true,
        "trademarks": [
          {
            "trademarkId": 123,
            "applicationNumber": "<string>",
            "registeredCountryCode": "<string>",
            "registered": 123,
            "expire": 123,
            "status": "<string>",
            "feature": "<string>",
            "word": "<string>",
            "mediaUrl": "<string>"
          }
        ],
        "hasTrademarks": true,
        "mostRecentSignatory": {
          "signatureDescription": "<string>",
          "firstSeenAt": 123
        },
        "currentRepresentatives": [
          {
            "personId": 123,
            "personalIdentityNumber": "<string>",
            "positionType": "<string>",
            "positionDescription": "<string>",
            "positionStart": 123,
            "positionEnd": 123,
            "fullName": "<string>",
            "roleByCompanyName": "<string>",
            "roleByCompanyRegistrationNumber": "<string>",
            "employeeRepresentative": true,
            "auditorType": "certifiedPublicAccountant",
            "bornYearMonthDay": "<string>"
          }
        ],
        "currentBeneficialOwners": [
          {
            "beneficialOwnerId": 123,
            "fromDate": 123,
            "personId": 123,
            "personalIdentityNumber": "<string>",
            "fullName": "<string>",
            "countryOfResidenceCode": "<string>",
            "citizenshipCountryCode": "<string>",
            "extentCode": "<string>",
            "extentDescription": "<string>",
            "governDescription": "<string>",
            "throughName": "<string>",
            "throughRegistrationNumber": "<string>",
            "bornYearMonthDay": "<string>"
          }
        ],
        "mostRecentShareCapital": {
          "shareCapitalAmount": 123,
          "shareCapitalLowerLimitAmount": 123,
          "shareCapitalHigherLimitAmount": 123,
          "shareCapitalISO4217CurrencyCode": "<string>",
          "numberOfShares": 123,
          "numberOfSharesLowerLimit": 123,
          "numberOfSharesHigherLimit": 123,
          "firstSeenAt": 123
        },
        "mostRecentDebtorSummary": {
          "foreclosure": true,
          "debtRestructuring": true,
          "recordOfPaymentApplications": {
            "numberOfCases": 123,
            "totalAmountInSEK": 123,
            "lastCaseDate": 123
          },
          "recordOfNonPayment": {
            "numberOfCases": 123,
            "totalAmountInSEK": 123,
            "lastCaseDate": 123
          },
          "debtBalance": {
            "lastUpdated": 123,
            "totalAmountInSEK": 123,
            "public": [
              {
                "description": "<string>",
                "totalAmountInSEK": 123,
                "numberOfCases": 123
              }
            ],
            "private": {
              "numberOfCases": 123,
              "totalAmountInSEK": 123
            }
          }
        },
        "hasMostRecentDebtorSummary": true,
        "cNbrEmployeesInterval": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "c_VATInterval": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cTurnoverInterval": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cPropertyTaxationInterval": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cSector": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cTradeAfrica": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cTradeAsia": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cTradeEU": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cTradeExportInterval": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cTradeFarEast": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cTradeImportInterval": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cTradeNorthCentralAmerica": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cTradeNordics": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cTradeSouthAmerica": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cTradeOtherEurope": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cGenderRatioFemale": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cGenderRatioMale": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cPrivPubl": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        },
        "cOwnership": {
          "categoryCode": 123,
          "categoryCodeDescription": "<string>",
          "categoryCode2": 123,
          "categoryCodeDescription2": "<string>"
        }
      },
      "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,
          "iso3166CountryCode": "<string>",
          "registrationNumber": "<string>",
          "legalEntityType": "<string>",
          "localCompanyCode": "<string>",
          "elfCode": "<string>",
          "registrationDate": 123,
          "ceasedDate": 123,
          "isCeased": true,
          "mostRecentPurpose": "<string>",
          "activityStatus": "hasNeverBeenActive",
          "mostRecentRegisteredAddress": {
            "co": "<string>",
            "streetAddress": "<string>",
            "postalCode": "<string>",
            "city": "<string>",
            "countryCodeAlpha3": "<string>",
            "location": [
              123
            ],
            "firstSeenAt": 123
          },
          "mostRecentMailingAddress": {
            "co": "<string>",
            "streetAddress": "<string>",
            "postalCode": "<string>",
            "city": "<string>",
            "countryCodeAlpha3": "<string>",
            "location": [
              123
            ],
            "firstSeenAt": 123
          },
          "mostRecentVisitingAddress": {
            "co": "<string>",
            "streetAddress": "<string>",
            "postalCode": "<string>",
            "city": "<string>",
            "countryCodeAlpha3": "<string>",
            "location": [
              123
            ],
            "firstSeenAt": 123
          },
          "currentWorkplaces": [
            {
              "companyWorkplaceId": 123,
              "workplaceCode": 123,
              "mostRecentName": "<string>",
              "labelAddress": "<string>",
              "location": [
                123
              ]
            }
          ],
          "names": [
            {
              "nameOrIdentifier": "<string>",
              "companyNamingType": "legalName",
              "firstSeenAt": 123
            }
          ],
          "registeredOffices": [
            {
              "municipality": "<string>",
              "municipalityCode": "<string>",
              "county": "<string>",
              "countyCode": "<string>",
              "firstSeenAt": 123
            }
          ],
          "phoneNumbers": [
            {
              "e164PhoneNumber": "<string>",
              "phoneNumberType": "fixedLine",
              "numberPlanServiceType": "<string>",
              "orginalOperator": "<string>",
              "priorOperator": "<string>",
              "currentOperator": "<string>",
              "lastPortingDate": 123
            }
          ],
          "hasPhoneNumbers": true,
          "emailAddresses": [
            {
              "emailAddress": "<string>",
              "emailAddressType": "general"
            }
          ],
          "hasEmailAddresses": true,
          "hyperlinks": [
            {
              "hyperlink": "<string>",
              "hyperlinkType": "homepage"
            }
          ],
          "hasHyperlinks": true,
          "sniCodes": [
            {
              "sni_2007Code": "<string>",
              "sni_2007Name": "<string>",
              "rank": 123
            }
          ],
          "intelligence": [
            {
              "companyIntelligenceType": "createdAsShelfCompany",
              "companyIntelligenceSubType": "<string>",
              "notes": "<string>",
              "score": 123,
              "firstSeenAt": 123,
              "documentUrl": "<string>"
            }
          ],
          "hasIntelligence": true,
          "status": [
            {
              "companyStatusType": "reorganizationOfBusinessCommenced",
              "statusDate": 123,
              "statusDescription": "<string>"
            }
          ],
          "hasStatus": true,
          "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>"
          },
          "hasMostRecentFinancialSummary": true,
          "isRegisteredForVAT": true,
          "isRegisteredForFTax": true,
          "isRegisteredForPayroll": true,
          "registration": [
            {
              "companyRegistrationType": "fTax",
              "companyRegistrationSubType": "<string>",
              "isRegistered": true,
              "registeredFrom": 123,
              "registeredTo": 123,
              "terminationReasonIfAny": "<string>",
              "firstSeenAt": 123
            }
          ],
          "ftaxTerminationReason": "<string>",
          "bankAccounts": [
            {
              "bankAccountType": "bankgiro",
              "accountNumber": "<string>",
              "swift_BIC": "<string>"
            }
          ],
          "hasBankAccounts": true,
          "documents": [
            {
              "companyDocumentId": 123,
              "companyDocumentType": "annualReport",
              "documentDate": 123,
              "documentTitle": "<string>",
              "documentVersion": "<string>",
              "documentValue1": "<string>",
              "documentValue2": "<string>",
              "documentValue3": "<string>",
              "grossPriceIfAny": 123,
              "documentUrl": "<string>"
            }
          ],
          "hasDocuments": true,
          "lastAnnualReportDate": 123,
          "stock": {
            "isin": "<string>",
            "ticker": "<string>",
            "yahooSymbol": "<string>",
            "marketName": "<string>",
            "marketExchangeName": "<string>",
            "marketCountryCodeAlpha3": "<string>",
            "sectorName": "<string>",
            "branchName": "<string>",
            "listingDate": 123,
            "enterpriseValue": 123,
            "enterpriseValueUpdated": 123,
            "stockQuote": 123,
            "stockQuoteUpdated": 123,
            "nextReportDate": 123,
            "nextReportType": "<string>",
            "dividendExDate": 123,
            "dividendsPerYear": 123,
            "dividendAmount": 123,
            "dividendCurrency": "<string>"
          },
          "hasStock": true,
          "lei": {
            "leiCode": "<string>",
            "registrationStatus": "<string>",
            "initialRegistrationDate": 123,
            "nextRenewalDate": 123,
            "managingLOU": "<string>",
            "managingLOULegalName": "<string>"
          },
          "hasLEI": true,
          "salesToPublicActors": [
            {
              "actorName": "<string>",
              "actorType": "<string>",
              "actorCode": "<string>",
              "sales": [
                {
                  "year": 123,
                  "approxInvoicedK": 123
                }
              ]
            }
          ],
          "hasSalesToPublicActors": true,
          "ecParticipant": {
            "pic": "<string>",
            "validationStatus": "<string>",
            "numberOfProjects": 123,
            "workProgrammesData": "<any>",
            "lastUpdated": 123
          },
          "hasECParticipant": true,
          "franchisesOrLicences": [
            {
              "linkedToName": "<string>",
              "linkedToCompanyId": 123,
              "actingUnderName": "<string>",
              "description": "<string>",
              "companyFranchiseOrLicenceType": "franchise",
              "data": [
                "<any>"
              ]
            }
          ],
          "hasFranchisesOrLicences": true,
          "trademarks": [
            {
              "trademarkId": 123,
              "applicationNumber": "<string>",
              "registeredCountryCode": "<string>",
              "registered": 123,
              "expire": 123,
              "status": "<string>",
              "feature": "<string>",
              "word": "<string>",
              "mediaUrl": "<string>"
            }
          ],
          "hasTrademarks": true,
          "mostRecentSignatory": {
            "signatureDescription": "<string>",
            "firstSeenAt": 123
          },
          "currentRepresentatives": [
            {
              "personId": 123,
              "personalIdentityNumber": "<string>",
              "positionType": "<string>",
              "positionDescription": "<string>",
              "positionStart": 123,
              "positionEnd": 123,
              "fullName": "<string>",
              "roleByCompanyName": "<string>",
              "roleByCompanyRegistrationNumber": "<string>",
              "employeeRepresentative": true,
              "auditorType": "certifiedPublicAccountant",
              "bornYearMonthDay": "<string>"
            }
          ],
          "currentBeneficialOwners": [
            {
              "beneficialOwnerId": 123,
              "fromDate": 123,
              "personId": 123,
              "personalIdentityNumber": "<string>",
              "fullName": "<string>",
              "countryOfResidenceCode": "<string>",
              "citizenshipCountryCode": "<string>",
              "extentCode": "<string>",
              "extentDescription": "<string>",
              "governDescription": "<string>",
              "throughName": "<string>",
              "throughRegistrationNumber": "<string>",
              "bornYearMonthDay": "<string>"
            }
          ],
          "mostRecentShareCapital": {
            "shareCapitalAmount": 123,
            "shareCapitalLowerLimitAmount": 123,
            "shareCapitalHigherLimitAmount": 123,
            "shareCapitalISO4217CurrencyCode": "<string>",
            "numberOfShares": 123,
            "numberOfSharesLowerLimit": 123,
            "numberOfSharesHigherLimit": 123,
            "firstSeenAt": 123
          },
          "mostRecentDebtorSummary": {
            "foreclosure": true,
            "debtRestructuring": true,
            "recordOfPaymentApplications": {
              "numberOfCases": 123,
              "totalAmountInSEK": 123,
              "lastCaseDate": 123
            },
            "recordOfNonPayment": {
              "numberOfCases": 123,
              "totalAmountInSEK": 123,
              "lastCaseDate": 123
            },
            "debtBalance": {
              "lastUpdated": 123,
              "totalAmountInSEK": 123,
              "public": [
                {
                  "description": "<string>",
                  "totalAmountInSEK": 123,
                  "numberOfCases": 123
                }
              ],
              "private": {
                "numberOfCases": 123,
                "totalAmountInSEK": 123
              }
            }
          },
          "hasMostRecentDebtorSummary": true,
          "cNbrEmployeesInterval": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "c_VATInterval": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cTurnoverInterval": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cPropertyTaxationInterval": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cSector": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cTradeAfrica": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cTradeAsia": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cTradeEU": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cTradeExportInterval": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cTradeFarEast": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cTradeImportInterval": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cTradeNorthCentralAmerica": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cTradeNordics": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cTradeSouthAmerica": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cTradeOtherEurope": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cGenderRatioFemale": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cGenderRatioMale": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cPrivPubl": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          },
          "cOwnership": {
            "categoryCode": 123,
            "categoryCodeDescription": "<string>",
            "categoryCode2": 123,
            "categoryCodeDescription2": "<string>"
          }
        },
        "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
}

This endpoint can be used by reseller created accounts for free usages. It contains a limited number of fields.

Check our extensive examples and description here.

You can add &view=html to your querystring and we will render an html page with explanations.

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