{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources. Success responses include a `source` block to cite. Apizie Finance endpoints (SEC EDGAR, FRED, ECB, U.S. Treasury, GLEIF, World Bank, official:*) need a Finance plan."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/search-tools:owler/basic-company-search":{"get":{"operationId":"search_tools_owler_basic_company_search","summary":"Basic Search Company by Ticker or Website or Name or PermID","description":"GET /v1/company/basicsearch","tags":["search-tools"],"x-apizie-access":"read","parameters":[{"name":"q","in":"query","required":true,"description":"Search term","schema":{"type":"string","description":"Search term"}},{"name":"fields","in":"query","required":false,"description":"Fields to be searched - name, website, ticker, permid. If not specfied, will be searched against all fields","schema":{"type":"array","description":"Fields to be searched - name, website, ticker, permid. If not specfied, will be searched against all fields"}},{"name":"limit","in":"query","required":false,"description":"Number of results to be displayed - 10 (by default, if not specified) to 30","schema":{"type":"string","description":"Number of results to be displayed - 10 (by default, if not specified) to 30"}},{"name":"format","in":"query","required":false,"description":"Format of the response content - json (by default if not specified), xml","schema":{"type":"string","enum":["xml","json"],"default":"json","description":"Format of the response content - json (by default if not specified), xml"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:owler/get-v1-company-competitor-id-company-id":{"get":{"operationId":"search_tools_owler_get_v1_company_competitor_id_company_id","summary":"Get Competitor information by Id","description":"GET /v1/company/competitor/id/{companyId}","tags":["search-tools"],"x-apizie-access":"read","parameters":[{"name":"companyId","in":"query","required":true,"description":"Company Id","schema":{"type":"string","description":"Company Id"}},{"name":"format","in":"query","required":false,"description":"Format of the response content - json (by default if not specified), xml","schema":{"type":"string","enum":["xml","json"],"default":"json","description":"Format of the response content - json (by default if not specified), xml"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:owler/get-v1-company-competitor-url-website":{"get":{"operationId":"search_tools_owler_get_v1_company_competitor_url_website","summary":"Get Competitor information by URL","description":"GET /v1/company/competitor/url/{website}","tags":["search-tools"],"x-apizie-access":"read","parameters":[{"name":"website","in":"query","required":true,"description":"Company Id","schema":{"type":"string","description":"Company Id"}},{"name":"format","in":"query","required":false,"description":"Format of the response content - json (by default if not specified), xml","schema":{"type":"string","enum":["xml","json"],"default":"json","description":"Format of the response content - json (by default if not specified), xml"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:owler/get-v1-company-competitorpremium-id-company-id":{"get":{"operationId":"search_tools_owler_get_v1_company_competitorpremium_id_company_id","summary":"Get Competitor information by Id","description":"GET /v1/company/competitorpremium/id/{companyId}","tags":["search-tools"],"x-apizie-access":"read","parameters":[{"name":"companyId","in":"query","required":true,"description":"Company Id","schema":{"type":"string","description":"Company Id"}},{"name":"pagination_id","in":"query","required":false,"description":"Pass pagination_id as * in the first API request. The API response will return top competitors along with the next pagination_id which can…","schema":{"type":"string","description":"Pass pagination_id as * in the first API request. The API response will return top competitors along with the next pagination_id which can…"}},{"name":"format","in":"query","required":false,"description":"Format of the response content - json (by default if not specified), xml","schema":{"type":"string","enum":["xml","json"],"default":"json","description":"Format of the response content - json (by default if not specified), xml"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:owler/get-v1-company-competitorpremium-url-website":{"get":{"operationId":"search_tools_owler_get_v1_company_competitorpremium_url_website","summary":"Get Competitor information by Url","description":"GET /v1/company/competitorpremium/url/{website}","tags":["search-tools"],"x-apizie-access":"read","parameters":[{"name":"website","in":"query","required":true,"description":"Company Id","schema":{"type":"string","description":"Company Id"}},{"name":"pagination_id","in":"query","required":false,"description":"Pass pagination_id as * in the first API request. The API response will return top competitors along with the next pagination_id which can…","schema":{"type":"string","description":"Pass pagination_id as * in the first API request. The API response will return top competitors along with the next pagination_id which can…"}},{"name":"format","in":"query","required":false,"description":"Format of the response content - json (by default if not specified), xml","schema":{"type":"string","enum":["xml","json"],"default":"json","description":"Format of the response content - json (by default if not specified), xml"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:owler/fuzzy-company-search":{"get":{"operationId":"search_tools_owler_fuzzy_company_search","summary":"Fuzzy Search Company by Name or Address or Phone","description":"GET /v1/company/fuzzysearch","tags":["search-tools"],"x-apizie-access":"read","parameters":[{"name":"q","in":"query","required":true,"description":"Search term","schema":{"type":"string","description":"Search term"}},{"name":"fields","in":"query","required":true,"description":"Fields to be searched - name, website, ticker, permid, address, phone. Each field and its corresponding value has to be specified","schema":{"type":"array","description":"Fields to be searched - name, website, ticker, permid, address, phone. Each field and its corresponding value has to be specified"}},{"name":"limit","in":"query","required":false,"description":"Number of results to be displayed - 10 (by default, if not specified) to 30","schema":{"type":"string","description":"Number of results to be displayed - 10 (by default, if not specified) to 30"}},{"name":"format","in":"query","required":false,"description":"Format of the response content - json (by default if not specified), xml","schema":{"type":"string","enum":["xml","json"],"default":"json","description":"Format of the response content - json (by default if not specified), xml"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:owler/get-v1-company-id-company-id":{"get":{"operationId":"search_tools_owler_get_v1_company_id_company_id","summary":"Get Company by Id","description":"GET /v1/company/id/{companyId}","tags":["search-tools"],"x-apizie-access":"read","parameters":[{"name":"companyId","in":"query","required":true,"description":"Company Id","schema":{"type":"string","description":"Company Id"}},{"name":"format","in":"query","required":false,"description":"Format of the response content - json (by default if not specified), xml","schema":{"type":"string","enum":["xml","json"],"default":"json","description":"Format of the response content - json (by default if not specified), xml"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:owler/search-company":{"get":{"operationId":"search_tools_owler_search_company","summary":"Search Company by Ticker or Website or Name or PermID","description":"GET /v1/company/search","tags":["search-tools"],"x-apizie-access":"read","parameters":[{"name":"q","in":"query","required":true,"description":"Search term","schema":{"type":"string","description":"Search term"}},{"name":"fields","in":"query","required":false,"description":"Fields to be searched - name, website, ticker. If not specified, will be searched against all fields","schema":{"type":"array","description":"Fields to be searched - name, website, ticker. If not specified, will be searched against all fields"}},{"name":"limit","in":"query","required":false,"description":"Number of results to be displayed - 10 (by default, if not specified) to 30","schema":{"type":"string","description":"Number of results to be displayed - 10 (by default, if not specified) to 30"}},{"name":"format","in":"query","required":false,"description":"Format of the response content - json (by default if not specified), xml","schema":{"type":"string","enum":["xml","json"],"default":"json","description":"Format of the response content - json (by default if not specified), xml"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:owler/get-v1-company-url-website":{"get":{"operationId":"search_tools_owler_get_v1_company_url_website","summary":"Get Company by URL","description":"GET /v1/company/url/{website}","tags":["search-tools"],"x-apizie-access":"read","parameters":[{"name":"website","in":"query","required":true,"description":"Company Domain","schema":{"type":"string","description":"Company Domain"}},{"name":"format","in":"query","required":false,"description":"Format of the response content - json (by default if not specified), xml","schema":{"type":"string","enum":["xml","json"],"default":"json","description":"Format of the response content - json (by default if not specified), xml"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:owler/get-v1-companypremium-id-company-id":{"get":{"operationId":"search_tools_owler_get_v1_companypremium_id_company_id","summary":"Get Complete Company Info by Id","description":"GET /v1/companypremium/id/{companyId}","tags":["search-tools"],"x-apizie-access":"read","parameters":[{"name":"companyId","in":"query","required":true,"description":"Company Id","schema":{"type":"string","description":"Company Id"}},{"name":"format","in":"query","required":false,"description":"Format of the response content - json (by default if not specified), xml","schema":{"type":"string","enum":["xml","json"],"default":"json","description":"Format of the response content - json (by default if not specified), xml"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:owler/get-v1-companypremium-url-website":{"get":{"operationId":"search_tools_owler_get_v1_companypremium_url_website","summary":"Get Basic Company Info by Url","description":"GET /v1/companypremium/url/{website}","tags":["search-tools"],"x-apizie-access":"read","parameters":[{"name":"website","in":"query","required":true,"description":"Company Domain","schema":{"type":"string","description":"Company Domain"}},{"name":"format","in":"query","required":false,"description":"Format of the response content - json (by default if not specified), xml","schema":{"type":"string","enum":["xml","json"],"default":"json","description":"Format of the response content - json (by default if not specified), xml"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:owler/get-v1-feed":{"get":{"operationId":"search_tools_owler_get_v1_feed","summary":"Get Feeds for given Company Ids","description":"GET /v1/feed","tags":["search-tools"],"x-apizie-access":"read","parameters":[{"name":"format","in":"query","required":false,"description":"Format of the response content - json (by default if not specified), xml","schema":{"type":"string","enum":["xml","json"],"default":"json","description":"Format of the response content - json (by default if not specified), xml"}},{"name":"company_id","in":"query","required":true,"description":"Company Ids separated by comma (Maximum of 150 Company Ids)","schema":{"type":"array","description":"Company Ids separated by comma (Maximum of 150 Company Ids)"}},{"name":"limit","in":"query","required":false,"description":"Number of results to be displayed - 10 (by default, if not specified) to 100","schema":{"type":"string","default":"10","description":"Number of results to be displayed - 10 (by default, if not specified) to 100"}},{"name":"pagination_id","in":"query","required":false,"description":"Pass pagination_id as blank in the first API request. The API response will return the latest feeds along with the next pagination_id…","schema":{"type":"string","default":"*","description":"Pass pagination_id as blank in the first API request. The API response will return the latest feeds along with the next pagination_id…"}},{"name":"category","in":"query","required":false,"description":"Categories separated by comma. If not specified, will search against all categories","schema":{"type":"array","description":"Categories separated by comma. If not specified, will search against all categories"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/search-tools:owler/get-v1-feed-url":{"get":{"operationId":"search_tools_owler_get_v1_feed_url","summary":"Get Feeds for given Company Websites","description":"GET /v1/feed/url","tags":["search-tools"],"x-apizie-access":"read","parameters":[{"name":"format","in":"query","required":false,"description":"Format of the response content - json (by default if not specified), xml","schema":{"type":"string","enum":["xml","json"],"default":"json","description":"Format of the response content - json (by default if not specified), xml"}},{"name":"domain","in":"query","required":true,"description":"Company Websites separated by comma (Maximum of 10 Company Websites)","schema":{"type":"array","description":"Company Websites separated by comma (Maximum of 10 Company Websites)"}},{"name":"limit","in":"query","required":false,"description":"Number of results to be displayed - 10 (by default, if not specified) to 100","schema":{"type":"string","default":"10","description":"Number of results to be displayed - 10 (by default, if not specified) to 100"}},{"name":"pagination_id","in":"query","required":false,"description":"Pass pagination_id as blank in the first API request. The API response will return the latest feeds along with the next pagination_id…","schema":{"type":"string","default":"*","description":"Pass pagination_id as blank in the first API request. The API response will return the latest feeds along with the next pagination_id…"}},{"name":"category","in":"query","required":false,"description":"Categories separated by comma. If not specified, will search against all categories","schema":{"type":"array","description":"Categories separated by comma. If not specified, will search against all categories"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"official:company"},"data":{},"source":{"type":"object","description":"Where the data came from. Cite it.","properties":{"official":{"type":"boolean"},"provider":{"type":"string","example":"SEC EDGAR"},"publisher":{"type":"string","example":"U.S. Securities and Exchange Commission"},"url":{"type":"string","format":"uri","description":"A page a person can open to check the value"},"apiUrl":{"type":"string","format":"uri","description":"The official API URL that was called (credentials removed)"},"retrievedAt":{"type":"string","format":"date-time"},"license":{"type":"string"},"licenseUrl":{"type":"string","format":"uri"},"attribution":{"type":"string"},"notice":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}