---
agentTools:
  projectIndex: https://worldbox-api.readme.io/llms.txt
---

# Company Search

Search in our worldwide company index

Worldbox provides company reports on every country in the world.\
If the information on a specific company is not available it can be ordered by the entry of the company name, address, and country.

Search for companies in the Worldbox index. The search string must have a minimum length of three characters.\
It is not possible to search worldwide at the moment therefore the country code is mandatory.

```javascript
$.get('https://api.worldbox.ch/v1/companies/?q=' + q+'&countrycode='+countrycode, function(data) {
    console.log(data);
});
```

As a result, the Webservice returns as a list of found companies including  “Win”-number, company name, and current status either active or dissolved. The response will be a JSON object containing the list of companies (array) with a max of 150 records.

```json
{
    "messages": [],
    "countrycode": "CH",
    "searchterm": "Worldbox AG",
    "recordcount": 1,
    "companies": [
        {
            "win": "CH0000163067",
            "country": "CH",
            "street": "Breitackerstrasse 1",
            "status": "active",
            "legalform": "Company limited by shares",
            "name": "Worldbox AG",
            "city": "Zollikon",
            "regnr": "020.3.901.907-9",
            "postcode": "8702"
        }
    ],
    "city": ""
```

If the response list is with more than 150 records, then you will receive an empty list and a message of too many hits - a finetune of the search is required.

```json Result
{
    "messages": [
        "WorldboxSearch returned too many hits (636)"
    ],
    "countrycode": "CH",
    "searchterm": "abb",
    "recordcount": 636,
    "companies": [],
    "city": ""
}
```

Note: **WIN** Number is the Worldbox unique company identification code and "**regnr**" is the company register number

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "API Settings",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://testapi.worldbox.ch/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/companies/?q=Worldbox&countrycode=CH": {
      "get": {
        "summary": "Company Search",
        "description": "Search in our worldwide company index",
        "operationId": "search",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "description": "The search string with min. length of 3  characters (Name or registered number)",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "countrycode",
            "in": "query",
            "description": "The countrycode of the country to be searched in. Must be an ISO 3166 Country Codes.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n   companies: [\n    {\n        win: \"CH0000163067\",\n        name: \"Worldbox AG\";\n        status: \"active\",\n        country: \"CH\",\n        city: \"Zollikon\",\n        postcode: \"8702\",\n        street: \"Breitackerstrasse 1\",\n        regnr: \"020.3.901.907-9\"\n    }\n ],\n searchterm: \"Worldbox\",\n countrycode: \"CH\",\n city: \"Zollikon\", \n recordcount: 1,  \n}"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "6303ce04ea33c13c8859c3a3:54520e35fcaba808000c0ff0"
}
```