{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/dev-tools:link-fish/get-urls-apps":{"get":{"operationId":"dev_tools_link_fish_get_urls_apps","summary":"Get mobile apps","description":"GET /Urls/apps","tags":["dev-tools"],"parameters":[{"name":"url","in":"query","required":true,"description":"The URL of the website to query","schema":{"type":"string","description":"The URL of the website to query"}},{"name":"return_urls","in":"query","required":false,"description":"Returns app URLs instead of the identifiers","schema":{"type":"boolean","default":false,"description":"Returns app URLs instead of the identifiers"}},{"name":"browser_render","in":"query","required":false,"description":"If the page should be fully rendered with a browser to extract data. The request will then cost 5 credits instead of 1!","schema":{"type":"boolean","default":false,"description":"If the page should be fully rendered with a browser to extract data. The request will then cost 5 credits instead of 1!"}}],"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/dev-tools:link-fish/get-urls-browser-data":{"get":{"operationId":"dev_tools_link_fish_get_urls_browser_data","summary":"Extract data (browser)","description":"GET /Urls/browser-data","tags":["dev-tools"],"parameters":[{"name":"url","in":"query","required":true,"description":"The URL of the website to query","schema":{"type":"string","description":"The URL of the website to query"}},{"name":"item_format","in":"query","required":false,"description":"If the items should be return \"normal\" with multiple levels or \"flat\" with just one level and linked instead.","schema":{"type":"string","enum":["normal","flat"],"default":"normal","description":"If the items should be return \"normal\" with multiple levels or \"flat\" with just one level and linked instead."}},{"name":"simplify_special_types","in":"query","required":false,"description":"Some types like \"PropertyValue\" do save key and value in separate properties which makes the data harder to process. If this option gets…","schema":{"type":"boolean","default":false,"description":"Some types like \"PropertyValue\" do save key and value in separate properties which makes the data harder to process. If this option gets…"}},{"name":"include_raw_html","in":"query","required":false,"description":"Returns additionally also the raw HTML as property \"rawHtml\".","schema":{"type":"boolean","default":false,"description":"Returns additionally also the raw HTML as property \"rawHtml\"."}},{"name":"screenshot","in":"query","required":false,"description":"If and what kind of screenshot should be returned. Do only request screenshot generation when really needed because it will increase the…","schema":{"type":"string","enum":["none","normal","full"],"default":"none","description":"If and what kind of screenshot should be returned. Do only request screenshot generation when really needed because it will increase the…"}},{"name":"screenshot_width","in":"query","required":false,"description":"The widh of the screenshot in pixel.","schema":{"type":"integer","default":640,"description":"The widh of the screenshot in pixel."}},{"name":"screenshot_file_format","in":"query","required":false,"description":"The file format of the screenshot","schema":{"type":"string","enum":["png","jpg"],"default":"png","description":"The file format of the screenshot"}}],"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/dev-tools:link-fish/get-urls-browser-screenshot":{"get":{"operationId":"dev_tools_link_fish_get_urls_browser_screenshot","summary":"Generate screenshot (browser)","description":"GET /Urls/browser-screenshot","tags":["dev-tools"],"parameters":[{"name":"url","in":"query","required":true,"description":"The URL of the website to create screenshot of","schema":{"type":"string","description":"The URL of the website to create screenshot of"}},{"name":"type","in":"query","required":false,"description":"What kind of screenshot should be returned. If it should be a regular 16:9 screenshot or one with the full page height","schema":{"type":"string","enum":["normal","full"],"default":"normal","description":"What kind of screenshot should be returned. If it should be a regular 16:9 screenshot or one with the full page height"}},{"name":"file_format","in":"query","required":false,"description":"The file format of the screenshot","schema":{"type":"string","enum":["png","jpg"],"default":"png","description":"The file format of the screenshot"}},{"name":"width","in":"query","required":false,"description":"The widh of the screenshot in pixel.","schema":{"type":"integer","default":640,"description":"The widh of the screenshot in pixel."}}],"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/dev-tools:link-fish/get-urls-data":{"get":{"operationId":"dev_tools_link_fish_get_urls_data","summary":"Extract data","description":"GET /Urls/data","tags":["dev-tools"],"parameters":[{"name":"url","in":"query","required":true,"description":"The URL of the website to query","schema":{"type":"string","description":"The URL of the website to query"}},{"name":"item_format","in":"query","required":false,"description":"If the items should be return \"normal\" with multiple levels or \"flat\" with just one level and linked instead.","schema":{"type":"string","enum":["normal","flat"],"default":"normal","description":"If the items should be return \"normal\" with multiple levels or \"flat\" with just one level and linked instead."}},{"name":"simplify_special_types","in":"query","required":false,"description":"Some types like \"PropertyValue\" do save key and value in separate properties which makes the data harder to process. If this option gets…","schema":{"type":"boolean","default":false,"description":"Some types like \"PropertyValue\" do save key and value in separate properties which makes the data harder to process. If this option gets…"}},{"name":"include_raw_html","in":"query","required":false,"description":"Returns additionally also the raw HTML as property \"rawHtml\".","schema":{"type":"boolean","default":false,"description":"Returns additionally also the raw HTML as property \"rawHtml\"."}},{"name":"browser_render","in":"query","required":false,"description":"If the page should be fully rendered with a browser to extract data. The request will then cost 5 credits instead of 1!","schema":{"type":"boolean","default":false,"description":"If the page should be fully rendered with a browser to extract data. The request will then cost 5 credits instead of 1!"}}],"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/dev-tools:link-fish/get-urls-data-raw":{"get":{"operationId":"dev_tools_link_fish_get_urls_data_raw","summary":"Return data of JSON/XML","description":"GET /Urls/data-raw","tags":["dev-tools"],"parameters":[{"name":"url","in":"query","required":true,"description":"The URL to get the data of","schema":{"type":"string","description":"The URL to get the data of"}}],"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/dev-tools:link-fish/get-urls-data-tabular":{"get":{"operationId":"dev_tools_link_fish_get_urls_data_tabular","summary":"Return tabular data","description":"GET /Urls/data-tabular","tags":["dev-tools"],"parameters":[{"name":"url","in":"query","required":true,"description":"The URL to get the data of","schema":{"type":"string","description":"The URL to get the data of"}},{"name":"selector","in":"query","required":false,"description":"CSS selector to define tabular data which should get returned","schema":{"type":"string","description":"CSS selector to define tabular data which should get returned"}},{"name":"browser_render","in":"query","required":false,"description":"If the page should be fully rendered with a browser to extract data. The request will then cost 5 credits instead of 1!","schema":{"type":"boolean","default":false,"description":"If the page should be fully rendered with a browser to extract data. The request will then cost 5 credits instead of 1!"}}],"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/dev-tools:link-fish/get-urls-geo-coordinates":{"get":{"operationId":"dev_tools_link_fish_get_urls_geo_coordinates","summary":"Get geo coordinates","description":"GET /Urls/geo-coordinates","tags":["dev-tools"],"parameters":[{"name":"url","in":"query","required":true,"description":"The URL of the website to query","schema":{"type":"string","description":"The URL of the website to query"}},{"name":"browser_render","in":"query","required":false,"description":"If the page should be fully rendered with a browser to extract data. The request will then cost 5 credits instead of 1!","schema":{"type":"boolean","default":false,"description":"If the page should be fully rendered with a browser to extract data. The request will then cost 5 credits instead of 1!"}}],"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/dev-tools:link-fish/get-urls-social-media":{"get":{"operationId":"dev_tools_link_fish_get_urls_social_media","summary":"Get social media accounts","description":"GET /Urls/social-media","tags":["dev-tools"],"parameters":[{"name":"url","in":"query","required":true,"description":"The URL of the website to query","schema":{"type":"string","description":"The URL of the website to query"}},{"name":"return_urls","in":"query","required":false,"description":"Returns profile URLs instead of the profile names/ids","schema":{"type":"boolean","default":false,"description":"Returns profile URLs instead of the profile names/ids"}},{"name":"browser_render","in":"query","required":false,"description":"If the page should be fully rendered with a browser to extract data. The request will then cost 5 credits instead of 1!","schema":{"type":"boolean","default":false,"description":"If the page should be fully rendered with a browser to extract data. The request will then cost 5 credits instead of 1!"}}],"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":"dev-tools:hash"},"data":{},"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"}}}}}}}