{"_id":"55c53c115c5d9f0d004969b2","link_external":false,"link_url":"","__v":7,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","params":[]},"category":"55c53c105c5d9f0d004969b0","createdAt":"2015-08-07T23:15:29.130Z","githubsync":"","slug":"getting-started","sync_unique":"","type":"basic","updates":[],"body":"Welcome to the StackShare API (Closed Beta)! To request access to the StackShare API just sign up [here](https://stackshare.io/api).\n\nOur API has three main sets of endpoints: **Leads**, **Enrichment**, and **Tools**:\n\n  * **Leads:** helps you find companies using specific tool(s) that you search for. (e.g. companies that use React and MongoDB).\n  * **Enrichment:** gives you the entire tech stack for a company that you are searching for (e.g. the tech stack behind Instacart, which includes Rails, React, etc).\n  * **Tools:** allows you to query a technology name and get back basic metadata about that technology (e.g. description, website URL, etc).\n\nBy using the StackShare API you agree to abide by the [StackShare API Terms](https://stackshare.io/terms-api).\n\nPlease email us with any questions or concerns at [api@stackshare.io](mailto:api@stackshare.io).\n\nHappy Stacking!\n\n-StackShare Team","title":"Getting Started with The StackShare GraphQL API","user":"55c53bcf52a1ca0d00b1197b","excerpt":"This page will help you get started with StackShare GraphQL API ๐Ÿš€","hidden":false,"project":"55c53c0e5c5d9f0d004969ac","version":"55c53c0f5c5d9f0d004969af","isReference":false,"order":0,"metadata":{"title":"","description":"","image":[]},"parentDoc":null,"next":{"description":"","pages":[]},"childrenPages":[]}

Getting Started with The StackShare GraphQL API

This page will help you get started with StackShare GraphQL API ๐Ÿš€

Welcome to the StackShare API (Closed Beta)! To request access to the StackShare API just sign up [here](https://stackshare.io/api). Our API has three main sets of endpoints: **Leads**, **Enrichment**, and **Tools**: * **Leads:** helps you find companies using specific tool(s) that you search for. (e.g. companies that use React and MongoDB). * **Enrichment:** gives you the entire tech stack for a company that you are searching for (e.g. the tech stack behind Instacart, which includes Rails, React, etc). * **Tools:** allows you to query a technology name and get back basic metadata about that technology (e.g. description, website URL, etc). By using the StackShare API you agree to abide by the [StackShare API Terms](https://stackshare.io/terms-api). Please email us with any questions or concerns at [api@stackshare.io](mailto:api@stackshare.io). Happy Stacking! -StackShare Team
Welcome to the StackShare API (Closed Beta)! To request access to the StackShare API just sign up [here](https://stackshare.io/api). Our API has three main sets of endpoints: **Leads**, **Enrichment**, and **Tools**: * **Leads:** helps you find companies using specific tool(s) that you search for. (e.g. companies that use React and MongoDB). * **Enrichment:** gives you the entire tech stack for a company that you are searching for (e.g. the tech stack behind Instacart, which includes Rails, React, etc). * **Tools:** allows you to query a technology name and get back basic metadata about that technology (e.g. description, website URL, etc). By using the StackShare API you agree to abide by the [StackShare API Terms](https://stackshare.io/terms-api). Please email us with any questions or concerns at [api@stackshare.io](mailto:api@stackshare.io). Happy Stacking! -StackShare Team
{"_id":"5dcbfe015f934d001105e24a","project":"55c53c0e5c5d9f0d004969ac","version":"55c53c0f5c5d9f0d004969af","category":"55c53c105c5d9f0d004969b0","user":"5dcad2498884930395855d62","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-11-13T12:58:41.098Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:api-header]\n{\n  \"title\": \"How to get an API Token\"\n}\n[/block]\nYou can get an API token by signing up for a free trial or paid plan on [stackshare.io/api](https://stackshare.io/api). Your API key will be displayed on that page when you are signed in after you've selected a trial or plan.","excerpt":"How to get authenticated to StackShare.io","slug":"authentication","type":"basic","title":"Authentication","__v":0,"parentDoc":null,"childrenPages":[]}

Authentication

How to get authenticated to StackShare.io

[block:api-header] { "title": "How to get an API Token" } [/block] You can get an API token by signing up for a free trial or paid plan on [stackshare.io/api](https://stackshare.io/api). Your API key will be displayed on that page when you are signed in after you've selected a trial or plan.
[block:api-header] { "title": "How to get an API Token" } [/block] You can get an API token by signing up for a free trial or paid plan on [stackshare.io/api](https://stackshare.io/api). Your API key will be displayed on that page when you are signed in after you've selected a trial or plan.
{"_id":"5dcc01ded99df60025ed8746","project":"55c53c0e5c5d9f0d004969ac","version":"55c53c0f5c5d9f0d004969af","category":"55c53c105c5d9f0d004969b0","user":"5dcad2498884930395855d62","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-11-13T13:15:10.898Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"We recommend using [GraphiQL](https://stackshare.io/graphiql) as your StackShare API client.\n\n1 - Install GraphiQL: `brew cask install graphiql`\n2 - Start GraphiQL on your computer.\n3 - Then, enter api_address_insert in the GraphQL Endpoint box and select POST method.\n[block:api-header]\n{\n  \"title\": \"How to send a request using the API token\"\n}\n[/block]\nAfter getting the token, you need to set the header as <x-api-key>\n\nIf your client is GraphiQL, click button named as Edit HTTP Headers(shown at the image below).\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b7c7e0c-4b71e37-Screen_Shot_2019-11-13_at_15.53.06.png\",\n        \"4b71e37-Screen_Shot_2019-11-13_at_15.53.06.png\",\n        2040,\n        218,\n        \"#ececec\"\n      ]\n    }\n  ]\n}\n[/block]\nAfter that, click add header button(shown at the image below).\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/7513a3c-097d906-Screen_Shot_2019-11-13_at_15.55.51.png\",\n        \"097d906-Screen_Shot_2019-11-13_at_15.55.51.png\",\n        1870,\n        192,\n        \"#077ce3\"\n      ]\n    }\n  ]\n}\n[/block]\nThe header name is 'x-api-key' and value is from Part 1(How to get API token).\n[block:api-header]\n{\n  \"title\": \"GraphQL Query Example\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  enrichment(domain: \\\"airbnb.com\\\"){\\n    domain\\n    id\\n    companyTools {\\n      edges {\\n        node {\\n          id\\n          tool{\\n            id\\n            name\\n          }\\n          sourceSummary\\n          sources\\n        }\\n      }\\n    }\\n  }\\n}\\n\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/59417c1-Screen_Shot_2019-11-13_at_19.37.05.png\",\n        \"Screen Shot 2019-11-13 at 19.37.05.png\",\n        2044,\n        1410,\n        \"#f0f0f5\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"recommended-client-graphiql","type":"basic","title":"Recommended Client: GraphiQL","__v":0,"parentDoc":null,"childrenPages":[]}

Recommended Client: GraphiQL


We recommend using [GraphiQL](https://stackshare.io/graphiql) as your StackShare API client. 1 - Install GraphiQL: `brew cask install graphiql` 2 - Start GraphiQL on your computer. 3 - Then, enter api_address_insert in the GraphQL Endpoint box and select POST method. [block:api-header] { "title": "How to send a request using the API token" } [/block] After getting the token, you need to set the header as <x-api-key> If your client is GraphiQL, click button named as Edit HTTP Headers(shown at the image below). [block:image] { "images": [ { "image": [ "https://files.readme.io/b7c7e0c-4b71e37-Screen_Shot_2019-11-13_at_15.53.06.png", "4b71e37-Screen_Shot_2019-11-13_at_15.53.06.png", 2040, 218, "#ececec" ] } ] } [/block] After that, click add header button(shown at the image below). [block:image] { "images": [ { "image": [ "https://files.readme.io/7513a3c-097d906-Screen_Shot_2019-11-13_at_15.55.51.png", "097d906-Screen_Shot_2019-11-13_at_15.55.51.png", 1870, 192, "#077ce3" ] } ] } [/block] The header name is 'x-api-key' and value is from Part 1(How to get API token). [block:api-header] { "title": "GraphQL Query Example" } [/block] [block:code] { "codes": [ { "code": "{\n enrichment(domain: \"airbnb.com\"){\n domain\n id\n companyTools {\n edges {\n node {\n id\n tool{\n id\n name\n }\n sourceSummary\n sources\n }\n }\n }\n }\n}\n", "language": "json" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/59417c1-Screen_Shot_2019-11-13_at_19.37.05.png", "Screen Shot 2019-11-13 at 19.37.05.png", 2044, 1410, "#f0f0f5" ] } ] } [/block]
We recommend using [GraphiQL](https://stackshare.io/graphiql) as your StackShare API client. 1 - Install GraphiQL: `brew cask install graphiql` 2 - Start GraphiQL on your computer. 3 - Then, enter api_address_insert in the GraphQL Endpoint box and select POST method. [block:api-header] { "title": "How to send a request using the API token" } [/block] After getting the token, you need to set the header as <x-api-key> If your client is GraphiQL, click button named as Edit HTTP Headers(shown at the image below). [block:image] { "images": [ { "image": [ "https://files.readme.io/b7c7e0c-4b71e37-Screen_Shot_2019-11-13_at_15.53.06.png", "4b71e37-Screen_Shot_2019-11-13_at_15.53.06.png", 2040, 218, "#ececec" ] } ] } [/block] After that, click add header button(shown at the image below). [block:image] { "images": [ { "image": [ "https://files.readme.io/7513a3c-097d906-Screen_Shot_2019-11-13_at_15.55.51.png", "097d906-Screen_Shot_2019-11-13_at_15.55.51.png", 1870, 192, "#077ce3" ] } ] } [/block] The header name is 'x-api-key' and value is from Part 1(How to get API token). [block:api-header] { "title": "GraphQL Query Example" } [/block] [block:code] { "codes": [ { "code": "{\n enrichment(domain: \"airbnb.com\"){\n domain\n id\n companyTools {\n edges {\n node {\n id\n tool{\n id\n name\n }\n sourceSummary\n sources\n }\n }\n }\n }\n}\n", "language": "json" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/59417c1-Screen_Shot_2019-11-13_at_19.37.05.png", "Screen Shot 2019-11-13 at 19.37.05.png", 2044, 1410, "#f0f0f5" ] } ] } [/block]
{"_id":"5dd2ad6a16170c0011e80cac","project":"55c53c0e5c5d9f0d004969ac","version":"55c53c0f5c5d9f0d004969af","category":"55c53c105c5d9f0d004969b0","user":"5dcad2498884930395855d62","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-11-18T14:40:42.836Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"code":"{\n  tools(query: \"\", first: 5, after: \"\") {\n    pageInfo{\n      endCursor\n      hasNextPage\n    }\n    edges {     \n      node {\n        name\n        title\n        canonicalUrl\n        id\n        imageUrl\n        ossRepo\n        description\n        websiteUrl\n      }\n    }\n  }\n}","language":"text","name":"First Page"},{"code":"{\n  tools(query: \"\", first: 5, after: \"NQ\") {\n    pageInfo{\n      endCursor\n      hasNextPage\n    }\n    edges {     \n      node {\n        name\n        title\n        canonicalUrl\n        id\n        imageUrl\n        ossRepo\n        description\n        websiteUrl\n      }\n    }\n  }\n}","language":"text","name":"Second Page"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"data\": {\n    \"tools\": {\n      \"pageInfo\": {\n        \"endCursor\": \"NQ\",\n        \"hasNextPage\": true\n      },\n      \"edges\": [\n        {\n          \"node\": {\n            \"name\": \"Zeuscart\",\n            \"title\": null,\n            \"canonicalUrl\": null,\n            \"id\": \"VG9vbC05NjM=\",\n            \"imageUrl\": null,\n            \"ossRepo\": null,\n            \"description\": null,\n            \"websiteUrl\": null\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"CrossBox\",\n            \"title\": null,\n            \"canonicalUrl\": null,\n            \"id\": \"VG9vbC0xMTE4\",\n            \"imageUrl\": null,\n            \"ossRepo\": null,\n            \"description\": null,\n            \"websiteUrl\": null\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"Essential JS 2\",\n            \"title\": null,\n            \"canonicalUrl\": null,\n            \"id\": \"VG9vbC0xMTIw\",\n            \"imageUrl\": null,\n            \"ossRepo\": null,\n            \"description\": null,\n            \"websiteUrl\": null\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"Pingoteam\",\n            \"title\": null,\n            \"canonicalUrl\": null,\n            \"id\": \"VG9vbC0xMTIx\",\n            \"imageUrl\": null,\n            \"ossRepo\": null,\n            \"description\": null,\n            \"websiteUrl\": null\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"wisyCMS\",\n            \"title\": null,\n            \"canonicalUrl\": null,\n            \"id\": \"VG9vbC0xMTIz\",\n            \"imageUrl\": null,\n            \"ossRepo\": null,\n            \"description\": null,\n            \"websiteUrl\": null\n          }\n        }\n      ]\n    }\n  }\n}","name":"First Page Result"},{"status":200,"name":"Sacond Page Result","language":"text","code":"{\n  \"data\": {\n    \"tools\": {\n      \"pageInfo\": {\n        \"endCursor\": \"MTA\",\n        \"hasNextPage\": true\n      },\n      \"edges\": [\n        {\n          \"node\": {\n            \"name\": \"Yepcomm\",\n            \"title\": null,\n            \"canonicalUrl\": null,\n            \"id\": \"VG9vbC0xMTI0\",\n            \"imageUrl\": null,\n            \"ossRepo\": null,\n            \"description\": null,\n            \"websiteUrl\": null\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"RX Web Server\",\n            \"title\": null,\n            \"canonicalUrl\": null,\n            \"id\": \"VG9vbC0xMTI1\",\n            \"imageUrl\": null,\n            \"ossRepo\": null,\n            \"description\": null,\n            \"websiteUrl\": null\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"Doxygen\",\n            \"title\": null,\n            \"canonicalUrl\": null,\n            \"id\": \"VG9vbC0xMTE5\",\n            \"imageUrl\": null,\n            \"ossRepo\": null,\n            \"description\": null,\n            \"websiteUrl\": null\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"Adminer\",\n            \"title\": null,\n            \"canonicalUrl\": null,\n            \"id\": \"VG9vbC0xOQ==\",\n            \"imageUrl\": null,\n            \"ossRepo\": null,\n            \"description\": null,\n            \"websiteUrl\": null\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"ArvanCloud\",\n            \"title\": null,\n            \"canonicalUrl\": null,\n            \"id\": \"VG9vbC03NA==\",\n            \"imageUrl\": null,\n            \"ossRepo\": null,\n            \"description\": null,\n            \"websiteUrl\": null\n          }\n        }\n      ]\n    }\n  }\n}"}]},"settings":"","auth":"required","params":[{"_id":"5dd2ad6a16170c0011e80cae","ref":"","in":"query","required":false,"desc":"Returns the first n elements from the list. Max is 30.","default":"","type":"int","name":"first"},{"_id":"5dd2ad6a16170c0011e80cad","ref":"","in":"query","required":false,"desc":"Returns the elements in the list that come after the specified ID.","default":"","type":"string","name":"after"},{"_id":"5dd324405349c40038ffbf33","ref":"","in":"query","required":false,"desc":"Returns the last n elements from the list. Maximum is 30.","default":"","type":"int","name":"last"},{"_id":"5dd324405349c40038ffbf32","ref":"","in":"query","required":false,"desc":"Returns the elements in the list that come before the specified ID.","default":"","type":"string","name":"before"}],"url":"/graphql"},"isReference":false,"order":3,"body":"This is just an example and is applicable to other queries, too.","excerpt":"How to paginate using queries (for reference: https://facebook.github.io/relay/graphql/connections.htm)","slug":"pagination","type":"post","title":"Pagination","__v":11,"parentDoc":null,"childrenPages":[]}

postPagination

How to paginate using queries (for reference: https://facebook.github.io/relay/graphql/connections.htm)

Query Params

first:
integer
Returns the first n elements from the list. Max is 30.
after:
string
Returns the elements in the list that come after the specified ID.
last:
integer
Returns the last n elements from the list. Maximum is 30.
before:
string
Returns the elements in the list that come before the specified ID.
This is just an example and is applicable to other queries, too.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This is just an example and is applicable to other queries, too.
{"_id":"5dd2adfe250a5500320e96df","project":"55c53c0e5c5d9f0d004969ac","version":"55c53c0f5c5d9f0d004969af","category":"55c53c105c5d9f0d004969b0","user":"5dcad2498884930395855d62","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-11-18T14:43:10.564Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"language":"text","code":"{\n  tools(query: \"\", first: 5) {\n    pageInfo{\n      endCursor\n      hasNextPage\n    }\n    count\n    edges {     \n      node {\n        name\n        title\n        canonicalUrl\n        id\n        imageUrl\n        ossRepo\n        description\n        websiteUrl\n      }\n    }\n  }\n}"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"data\": {\n    \"tools\": {\n      \"pageInfo\": {\n        \"endCursor\": \"NQ\",\n        \"hasNextPage\": true\n      },\n      \"count\": 7654,\n      \"edges\": [\n        {\n          \"node\": {\n            \"name\": \"Zeuscart\",\n            \"title\": null,\n            \"canonicalUrl\": null,\n            \"id\": \"VG9vbC05NjM=\",\n            \"imageUrl\": null,\n            \"ossRepo\": null,\n            \"description\": null,\n            \"websiteUrl\": null\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"CrossBox\",\n            \"title\": null,\n            \"canonicalUrl\": null,\n            \"id\": \"VG9vbC0xMTE4\",\n            \"imageUrl\": null,\n            \"ossRepo\": null,\n            \"description\": null,\n            \"websiteUrl\": null\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"Essential JS 2\",\n            \"title\": null,\n            \"canonicalUrl\": null,\n            \"id\": \"VG9vbC0xMTIw\",\n            \"imageUrl\": null,\n            \"ossRepo\": null,\n            \"description\": null,\n            \"websiteUrl\": null\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"Pingoteam\",\n            \"title\": null,\n            \"canonicalUrl\": null,\n            \"id\": \"VG9vbC0xMTIx\",\n            \"imageUrl\": null,\n            \"ossRepo\": null,\n            \"description\": null,\n            \"websiteUrl\": null\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"wisyCMS\",\n            \"title\": null,\n            \"canonicalUrl\": null,\n            \"id\": \"VG9vbC0xMTIz\",\n            \"imageUrl\": null,\n            \"ossRepo\": null,\n            \"description\": null,\n            \"websiteUrl\": null\n          }\n        }\n      ]\n    }\n  }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":"/graphql"},"isReference":false,"order":4,"body":"Count gives the number of items on the query. This is applicable to other queries, too.","excerpt":"Include count in your query","slug":"count","type":"post","title":"Count","__v":0,"parentDoc":null,"childrenPages":[]}

postCount

Include count in your query

Count gives the number of items on the query. This is applicable to other queries, too.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Count gives the number of items on the query. This is applicable to other queries, too.
{"_id":"5dd46a5539649a00618f8082","project":"55c53c0e5c5d9f0d004969ac","version":"55c53c0f5c5d9f0d004969af","category":"55c53c105c5d9f0d004969b0","user":"55c53bcf52a1ca0d00b1197b","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-11-19T22:19:01.823Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"[block:api-header]\n{\n  \"title\": \"How are API requests counted?\"\n}\n[/block]\nAPI requests are counted differently based on the endpoint you are querying:\n\n  * Leads Endpoint - you are charged for every company result returned\n  * Enrichment Endpoint - you are charged for every page of tool results returned\n  * Tools Endpoint - you are not charged for any queries to this endpoint\n\nYou are also not charged for any company name searches you perform.","excerpt":"Frequently asked questions","slug":"faqs","type":"basic","title":"FAQs","__v":0,"parentDoc":null,"childrenPages":[]}

FAQs

Frequently asked questions

[block:api-header] { "title": "How are API requests counted?" } [/block] API requests are counted differently based on the endpoint you are querying: * Leads Endpoint - you are charged for every company result returned * Enrichment Endpoint - you are charged for every page of tool results returned * Tools Endpoint - you are not charged for any queries to this endpoint You are also not charged for any company name searches you perform.
[block:api-header] { "title": "How are API requests counted?" } [/block] API requests are counted differently based on the endpoint you are querying: * Leads Endpoint - you are charged for every company result returned * Enrichment Endpoint - you are charged for every page of tool results returned * Tools Endpoint - you are not charged for any queries to this endpoint You are also not charged for any company name searches you perform.
{"_id":"5dcbdd0c17009100116c28f4","project":"55c53c0e5c5d9f0d004969ac","version":"55c53c0f5c5d9f0d004969af","category":"5dcba0186f139a001aea4ab7","user":"5dcad2498884930395855d62","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-11-13T10:38:04.344Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"language":"text","code":"{\n  leads(usingToolIds: [\"VG9vbC01MzY=\", \"VG9vbC01NTI=\"], toolMatch: \"any\"){\n    edges{\n      node{\n        id\n        name\n        domain\n        companyTools{\n          edges{\n            node{\n              id\n              tool{\n                name\n              }\n              sources\n              sourceSummary\n            }\n          }\n        }\n      }\n    }\n  }\n}"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"data\": {\n    \"leads\": {\n      \"edges\": [\n        {\n          \"node\": {\n            \"id\": \"Q29tcGFueS00NjQ0NTQz\",\n            \"name\": \"mostlyneedlepoint.com\",\n            \"domain\": \"mostlyneedlepoint.com\",\n            \"companyTools\": {\n              \"edges\": [\n                {\n                  \"node\": {\n                    \"id\": \"Q29tcGFueVRvb2wtMTQ5OTYxMjU=\",\n                    \"tool\": {\n                      \"name\": \"MySQL\"\n                    },\n                    \"sources\": {\n                      \"website_source\": [\n                        {\n                          \"domain\": \"mostlyneedlepoint.com\",\n                          \"last_detected_at\": \"2019-09-26\",\n                          \"confidence\": 0\n                        }\n                      ]\n                    },\n                    \"sourceSummary\": {\n                      \"website_source\": 1\n                    }\n                  }\n                }\n              ]\n            }\n          }\n        },\n        {\n          \"node\": {\n            \"id\": \"Q29tcGFueS01NzUyMDI=\",\n            \"name\": \"Polson & Polson, P.C.\",\n            \"domain\": \"polsonlawfirm.com\",\n            \"companyTools\": {\n              \"edges\": [\n                {\n                  \"node\": {\n                    \"id\": \"Q29tcGFueVRvb2wtMzY1NTQ0Mw==\",\n                    \"tool\": {\n                      \"name\": \"MySQL\"\n                    },\n                    \"sources\": {\n                      \"website_source\": [\n                        {\n                          \"domain\": \"polsonlawfirm.com\",\n                          \"last_detected_at\": \"2019-09-25\",\n                          \"confidence\": 0\n                        }\n                      ]\n                    },\n                    \"sourceSummary\": {\n                      \"website_source\": 1\n                    }\n                  }\n                }\n              ]\n            }\n          }\n        }\n      ]\n    }\n  }\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5dcbdd0c17009100116c28f7","ref":"","in":"path","required":true,"desc":"The ids of tools that are being used by the companies","default":"[]","type":"array_string","name":"usingToolIds"},{"_id":"5dcbdd0c17009100116c28f6","ref":"","in":"path","required":true,"desc":"The ids of tools that are not being used by the companies","default":"[]","type":"array_string","name":"notUsingToolIds"},{"_id":"5dcbdd0c17009100116c28f5","ref":"","in":"path","required":true,"desc":"The search algorithm name, \"match_all\" is used to match both of the usingToolIds and notUsingToolIds and 'any' is used for any of those combination matched.","default":"","type":"string","name":"toolMatch"},{"_id":"5dcc01769aac7b0032646123","ref":"","in":"header","required":true,"desc":"The API token.","default":"","type":"string","name":"x-api-key"}],"url":"/graphql"},"isReference":false,"order":0,"body":"The api is used to search companies that are using the tools and/or not using the tools. \n\nIn the example query, we list the companies that are using **MongoDB**. \n\n**toolMatch Options**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Query\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"any\",\n    \"0-1\": \"The option matches any company that satisfies notUsingToolIds and/or usingToolIds. For example, the companies they are using Slack and/or Microsoft Team.\",\n    \"1-1\": \"The option matches the companies that satisfies notUsingToolIds and usingToolIds. For example, the companies they are using Heroku and Ruby on Rails\",\n    \"1-0\": \"match_all\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n**Response Fields** \n \n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"h-3\": \"Null?\",\n    \"0-0\": \"Id\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The id of the company.\",\n    \"0-3\": \"No\",\n    \"1-0\": \"name\",\n    \"2-0\": \"domain\",\n    \"1-1\": \"String\",\n    \"1-2\": \"The name of the company.\",\n    \"1-3\": \"No\",\n    \"2-2\": \"The domain of company\",\n    \"3-0\": \"companyTools\",\n    \"3-1\": \"Hash\",\n    \"2-1\": \"String\",\n    \"3-2\": \"The id of the node of itself, the tool fields, sources and sourceSummary\",\n    \"3-3\": \"Yes\",\n    \"2-3\": \"No\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]","excerpt":"Query to return a set of companies using specified technologies.","slug":"leads","type":"post","title":"Leads","__v":13,"parentDoc":null,"childrenPages":[]}

postLeads

Query to return a set of companies using specified technologies.

Path Params

usingToolIds:
required
array of strings[]
The ids of tools that are being used by the companies
notUsingToolIds:
required
array of strings[]
The ids of tools that are not being used by the companies
toolMatch:
required
string
The search algorithm name, "match_all" is used to match both of the usingToolIds and notUsingToolIds and 'any' is used for any of those combination matched.

Headers

x-api-key:
required
string
The API token.
The api is used to search companies that are using the tools and/or not using the tools. In the example query, we list the companies that are using **MongoDB**. **toolMatch Options** [block:parameters] { "data": { "h-0": "Query", "h-1": "Description", "0-0": "any", "0-1": "The option matches any company that satisfies notUsingToolIds and/or usingToolIds. For example, the companies they are using Slack and/or Microsoft Team.", "1-1": "The option matches the companies that satisfies notUsingToolIds and usingToolIds. For example, the companies they are using Heroku and Ruby on Rails", "1-0": "match_all" }, "cols": 2, "rows": 2 } [/block] **Response Fields** [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "h-3": "Null?", "0-0": "Id", "0-1": "String", "0-2": "The id of the company.", "0-3": "No", "1-0": "name", "2-0": "domain", "1-1": "String", "1-2": "The name of the company.", "1-3": "No", "2-2": "The domain of company", "3-0": "companyTools", "3-1": "Hash", "2-1": "String", "3-2": "The id of the node of itself, the tool fields, sources and sourceSummary", "3-3": "Yes", "2-3": "No" }, "cols": 4, "rows": 4 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The api is used to search companies that are using the tools and/or not using the tools. In the example query, we list the companies that are using **MongoDB**. **toolMatch Options** [block:parameters] { "data": { "h-0": "Query", "h-1": "Description", "0-0": "any", "0-1": "The option matches any company that satisfies notUsingToolIds and/or usingToolIds. For example, the companies they are using Slack and/or Microsoft Team.", "1-1": "The option matches the companies that satisfies notUsingToolIds and usingToolIds. For example, the companies they are using Heroku and Ruby on Rails", "1-0": "match_all" }, "cols": 2, "rows": 2 } [/block] **Response Fields** [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "h-3": "Null?", "0-0": "Id", "0-1": "String", "0-2": "The id of the company.", "0-3": "No", "1-0": "name", "2-0": "domain", "1-1": "String", "1-2": "The name of the company.", "1-3": "No", "2-2": "The domain of company", "3-0": "companyTools", "3-1": "Hash", "2-1": "String", "3-2": "The id of the node of itself, the tool fields, sources and sourceSummary", "3-3": "Yes", "2-3": "No" }, "cols": 4, "rows": 4 } [/block]
{"_id":"5dcbe4ed1d3a5400239183ea","project":"55c53c0e5c5d9f0d004969ac","version":"55c53c0f5c5d9f0d004969af","category":"5dcba0186f139a001aea4ab7","user":"5dcad2498884930395855d62","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-11-13T11:11:41.987Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"language":"json","code":"{\n  enrichment(domain: \"airbnb.com\"){\n    domain\n    id\n    companyTools {\n      edges {\n        node {\n          id\n          tool{\n            id\n            name\n          }\n          sourceSummary\n          sources\n        }\n      }\n    }\n  }\n}"}]},"results":{"codes":[{"status":200,"language":"json","code":"  \"data\": {\n    \"enrichment\": {\n      \"domain\": \"airbnb.com\",\n      \"id\": \"Q29tcGFueS0xMzA1NA==\",\n      \"companyTools\": {\n        \"edges\": [\n          {\n            \"node\": {\n              \"id\": \"Q29tcGFueVRvb2wtMTAzNA==\",\n              \"tool\": {\n                \"id\": \"VG9vbC01NjY=\",\n                \"name\": \"Nginx\"\n              },\n              \"sourceSummary\": {\n                \"website_source\": 56,\n                \"self_reported\": 1\n              },\n              \"sources\": {\n                \"website_source\": [\n                  {\n                    \"domain\": \"kokoasis.com\",\n                    \"last_detected_at\": \"2019-10-21\",\n                    \"confidence\": 100\n                  },\n                  {\n                    \"domain\": \"abnb.me\",\n                    \"last_detected_at\": \"2019-10-20\",\n                    \"confidence\": 100\n                  }\n                ]\n              }\n            }\n          },\n          {\n            \"node\": {\n              \"id\": \"Q29tcGFueVRvb2wtMjUwNDM5NTU=\",\n              \"tool\": {\n                \"id\": \"VG9vbC02OTg=\",\n                \"name\": \"Ruby\"\n              },\n              \"sourceSummary\": {\n                \"website_source\": 52,\n                \"self_reported\": 1\n              },\n              \"sources\": {\n                \"website_source\": [\n                  {\n                    \"domain\": \"th.airbnb.com\",\n                    \"last_detected_at\": \"2019-09-24\",\n                    \"confidence\": 0\n                  },\n                  {\n                    \"domain\": \"hr.airbnb.com\",\n                    \"last_detected_at\": \"2019-09-24\",\n                    \"confidence\": 0\n                  },\n                  {\n                    \"domain\": \"hi.airbnb.com\",\n                    \"last_detected_at\": \"2019-09-24\",\n                    \"confidence\": 0\n                  },\n                  {\n                    \"domain\": \"ko.airbnb.com\",\n                    \"last_detected_at\": \"2019-09-24\",\n                    \"confidence\": 0\n                  }\n                ],\n                \"self_reported\": [\n                  {\n                    \"last_reported_at\": \"2015-08-26\",\n                    \"confidence\": 100\n                  }\n                ]\n              }\n            }\n          }\n        ]\n      }\n    }\n  }\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5dcbe4ed1d3a5400239183ec","ref":"","in":"query","required":false,"desc":"The ID of the company that is searched.","default":"","type":"string","name":"id"},{"_id":"5dcbe4ed1d3a5400239183eb","ref":"","in":"query","required":false,"desc":"The domain of the company.","default":"","type":"string","name":"domain"},{"_id":"5dcc0186bb545100383a746f","ref":"","in":"header","required":true,"desc":"The API token.","default":"","type":"string","name":"x-api-key"}],"url":"/graphql"},"isReference":false,"order":1,"body":"This API is used to get the stacks of company by domain or id. However, at least one of them should be used.\n\n\n**Response fields**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"h-3\": \"Null?\",\n    \"0-0\": \"domain\",\n    \"1-0\": \"name\",\n    \"2-0\": \"id\",\n    \"3-0\": \"companyTools\",\n    \"0-1\": \"String\",\n    \"1-1\": \"String\",\n    \"2-1\": \"String\",\n    \"3-1\": \"Array of tools\",\n    \"0-2\": \"The domain of the company.\",\n    \"1-2\": \"The name of the company.\",\n    \"2-2\": \"The id of the company.\",\n    \"3-2\": \"The array of the tools with how we detected the usage of tools and the source summary.\",\n    \"0-3\": \"Yes\",\n    \"1-3\": \"Yes\",\n    \"2-3\": \"Yes\",\n    \"3-3\": \"Yes\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]","excerpt":"Query to return a company's tech stack based on their domain.","slug":"enrichment","type":"post","title":"Enrichment","__v":11,"parentDoc":null,"childrenPages":[]}

postEnrichment

Query to return a company's tech stack based on their domain.

Query Params

id:
string
The ID of the company that is searched.
domain:
string
The domain of the company.

Headers

x-api-key:
required
string
The API token.
This API is used to get the stacks of company by domain or id. However, at least one of them should be used. **Response fields** [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "h-3": "Null?", "0-0": "domain", "1-0": "name", "2-0": "id", "3-0": "companyTools", "0-1": "String", "1-1": "String", "2-1": "String", "3-1": "Array of tools", "0-2": "The domain of the company.", "1-2": "The name of the company.", "2-2": "The id of the company.", "3-2": "The array of the tools with how we detected the usage of tools and the source summary.", "0-3": "Yes", "1-3": "Yes", "2-3": "Yes", "3-3": "Yes" }, "cols": 4, "rows": 4 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



This API is used to get the stacks of company by domain or id. However, at least one of them should be used. **Response fields** [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "h-3": "Null?", "0-0": "domain", "1-0": "name", "2-0": "id", "3-0": "companyTools", "0-1": "String", "1-1": "String", "2-1": "String", "3-1": "Array of tools", "0-2": "The domain of the company.", "1-2": "The name of the company.", "2-2": "The id of the company.", "3-2": "The array of the tools with how we detected the usage of tools and the source summary.", "0-3": "Yes", "1-3": "Yes", "2-3": "Yes", "3-3": "Yes" }, "cols": 4, "rows": 4 } [/block]
{"_id":"5dcbd4fd4183a3005e8b7fc2","project":"55c53c0e5c5d9f0d004969ac","version":"55c53c0f5c5d9f0d004969af","category":"5dcba0186f139a001aea4ab7","user":"5dcad2498884930395855d62","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-11-13T10:03:41.098Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"data\": {\n    \"tools\": {\n      \"edges\": [\n        {\n          \"node\": {\n            \"name\": \"MongoDB\",\n            \"title\": \"The database for giant ideas\",\n            \"canonicalUrl\": \"/mongodb\",\n            \"id\": \"VG9vbC01MzY=\",\n            \"imageUrl\": \"https://img.stackshare.io/service/1030/leaf-360x360.png\",\n            \"ossRepo\": \"https://github.com/mongodb/mongo\",\n            \"description\": \"MongoDB stores data in JSON-like documents that can vary in structure, offering a dynamic, flexible schema. MongoDB was also designed for high availability and scalability, with built-in replication and auto-sharding.\",\n            \"websiteUrl\": \"http://www.mongodb.com/\"\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"MongoDB Cloud Manager\",\n            \"title\": \"A hosted platform for managing MongoDB \",\n            \"canonicalUrl\": \"/mongodb-cloud-manager\",\n            \"id\": \"VG9vbC0yNjk2\",\n            \"imageUrl\": \"https://img.stackshare.io/service/3557/J3fzYcnz_400x400.png\",\n            \"ossRepo\": \"\",\n            \"description\": \"It is a hosted platform for managing MongoDB on the infrastructure of your choice. It saves you time, money, and helps you protect your customer experience by eliminating the guesswork from running MongoDB.\",\n            \"websiteUrl\": \"https://www.mongodb.com/cloud/cloud-manager\"\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"MongoDB Atlas\",\n            \"title\": \"Deploy and scale a MongoDB cluster in the cloud with just a few clicks\",\n            \"canonicalUrl\": \"/mongodb-atlas\",\n            \"id\": \"VG9vbC0yMzI2\",\n            \"imageUrl\": \"https://img.stackshare.io/service/5739/atlas-360x360.png\",\n            \"ossRepo\": \"\",\n            \"description\": \"MongoDB Atlas is a global cloud database service built and run by the team behind MongoDB. Enjoy the flexibility and scalability of a document database, with the ease and automation of a fully managed service on your preferred cloud.\",\n            \"websiteUrl\": \"https://www.mongodb.com/cloud/atlas\"\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"MongoDB Stitch\",\n            \"title\": \"Backend as a Service for web and mobile applications\",\n            \"canonicalUrl\": \"/mongodb-stitch\",\n            \"id\": \"VG9vbC0yMzI1\",\n            \"imageUrl\": \"https://img.stackshare.io/service/7174/stitch-360x360.png\",\n            \"ossRepo\": \"\",\n            \"description\": \"MongoDB Stitch lets developers focus on building applications rather than on managing data manipulation code, service integration, or backend infrastructure. Stitch lets you focus on building the app users want, not on writing boilerplate backend logic.\",\n            \"websiteUrl\": \"https://www.mongodb.com/cloud/stitch\"\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"Percona Server for MongoDB\",\n            \"title\": \"Open source, drop-in replacement for the MongoDB\",\n            \"canonicalUrl\": \"/percona-server-for-mongodb\",\n            \"id\": \"VG9vbC01Mjkx\",\n            \"imageUrl\": \"https://img.stackshare.io/service/6400/Percona-Server-for-MongoDB.png\",\n            \"ossRepo\": \"https://github.com/percona/percona-server-mongodb\",\n            \"description\": \"It is a free, enhanced, fully compatible, open source, drop-in replacement for the MongoDB Community Edition that includes enterprise-grade features and functionality. Its storage engine options and enterprise-grade functionality provide enterprises with far greater flexibility for managing their database infrastructures.\",\n            \"websiteUrl\": \"https://www.percona.com/software/mongo-database/percona-server-for-mongodb\"\n          }\n        },\n        {\n          \"node\": {\n            \"name\": \"MongoDB Compass\",\n            \"title\": \"A GUI for MongoDB\",\n            \"canonicalUrl\": \"/mongodb-compass\",\n            \"id\": \"VG9vbC0zODU2\",\n            \"imageUrl\": \"https://img.stackshare.io/service/8696/J3fzYcnz_400x400.png\",\n            \"ossRepo\": \"\",\n            \"description\": \"Visually explore your data. Run ad hoc queries in seconds. Interact with your data with full CRUD functionality. View and optimize your query performance.\",\n            \"websiteUrl\": \"https://www.mongodb.com/products/compass\"\n          }\n        }\n      ]\n    }\n  }\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5dcbd5806c82c4005201abcb","ref":"","in":"query","required":true,"desc":"The name of the tool is searched","default":"","type":"string","name":"query"},{"_id":"5dcbdd9fef32910016778881","ref":"","in":"header","required":true,"desc":"The API token.","default":"","type":"string","name":"x-api-key"}],"url":"/graphql","examples":{"codes":[{"name":null,"language":"json","code":"{\n  tools(query: \"mongodb\") {\n    edges {\n      node {\n        name\n        title\n        canonicalUrl\n        id\n        imageUrl\n        ossRepo\n        description\n        websiteUrl\n      }\n    }\n  }\n}"}]},"method":"post"},"isReference":false,"order":2,"body":"Tools are including but not limited to technology, language, library which is on our database can be found. In other words, tools are defined as languages, frameworks, cloud infrastructure, business services, and open source projects (e.g. Heroku, Google Analytics, Rails, etc).\n\n**Tip**: This information is useful while searching companies that are using or are not using the tools. \n\n**Response Fields** \n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Name\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"h-3\": \"Null?\",\n    \"1-0\": \"id\",\n    \"1-1\": \"String\",\n    \"2-0\": \"title\",\n    \"3-0\": \"description\",\n    \"4-0\": \"websiteUrl\",\n    \"5-0\": \"imageUrl\",\n    \"6-0\": \"ossRepo\",\n    \"7-0\": \"canonicalUrl\",\n    \"0-1\": \"String\",\n    \"2-1\": \"String\",\n    \"3-1\": \"String\",\n    \"4-1\": \"String\",\n    \"5-1\": \"String\",\n    \"6-1\": \"String\",\n    \"7-1\": \"String\",\n    \"0-2\": \"The name of the tool.(ex: MySQL, mongoDB..)\",\n    \"1-2\": \"The ID of the tool.\",\n    \"2-2\": \"The title of the tool.\",\n    \"3-2\": \"The description of the tool.\",\n    \"4-2\": \"The website url of the tool.\",\n    \"5-2\": \"The image url of the tool.\",\n    \"6-2\": \"The url that you can follow the new releases, news and/or so on about the tool.\",\n    \"7-2\": \"The canonical path of the tool on StackShare.io(ie: \\\"/mongodb\\\").\",\n    \"0-3\": \"Yes\",\n    \"1-3\": \"Yes\",\n    \"2-3\": \"Yes\",\n    \"3-3\": \"Yes\",\n    \"4-3\": \"Yes\",\n    \"5-3\": \"Yes\",\n    \"6-3\": \"Yes\",\n    \"7-3\": \"Yes\"\n  },\n  \"cols\": 4,\n  \"rows\": 8\n}\n[/block]","excerpt":"Query to return basic information about a technology.","slug":"tools","type":"post","title":"Tools","__v":12,"parentDoc":null,"childrenPages":[]}

postTools

Query to return basic information about a technology.

Query Params

query:
required
string
The name of the tool is searched

Headers

x-api-key:
required
string
The API token.
Tools are including but not limited to technology, language, library which is on our database can be found. In other words, tools are defined as languages, frameworks, cloud infrastructure, business services, and open source projects (e.g. Heroku, Google Analytics, Rails, etc). **Tip**: This information is useful while searching companies that are using or are not using the tools. **Response Fields** [block:parameters] { "data": { "0-0": "Name", "h-0": "Name", "h-1": "Type", "h-2": "Description", "h-3": "Null?", "1-0": "id", "1-1": "String", "2-0": "title", "3-0": "description", "4-0": "websiteUrl", "5-0": "imageUrl", "6-0": "ossRepo", "7-0": "canonicalUrl", "0-1": "String", "2-1": "String", "3-1": "String", "4-1": "String", "5-1": "String", "6-1": "String", "7-1": "String", "0-2": "The name of the tool.(ex: MySQL, mongoDB..)", "1-2": "The ID of the tool.", "2-2": "The title of the tool.", "3-2": "The description of the tool.", "4-2": "The website url of the tool.", "5-2": "The image url of the tool.", "6-2": "The url that you can follow the new releases, news and/or so on about the tool.", "7-2": "The canonical path of the tool on StackShare.io(ie: \"/mongodb\").", "0-3": "Yes", "1-3": "Yes", "2-3": "Yes", "3-3": "Yes", "4-3": "Yes", "5-3": "Yes", "6-3": "Yes", "7-3": "Yes" }, "cols": 4, "rows": 8 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Tools are including but not limited to technology, language, library which is on our database can be found. In other words, tools are defined as languages, frameworks, cloud infrastructure, business services, and open source projects (e.g. Heroku, Google Analytics, Rails, etc). **Tip**: This information is useful while searching companies that are using or are not using the tools. **Response Fields** [block:parameters] { "data": { "0-0": "Name", "h-0": "Name", "h-1": "Type", "h-2": "Description", "h-3": "Null?", "1-0": "id", "1-1": "String", "2-0": "title", "3-0": "description", "4-0": "websiteUrl", "5-0": "imageUrl", "6-0": "ossRepo", "7-0": "canonicalUrl", "0-1": "String", "2-1": "String", "3-1": "String", "4-1": "String", "5-1": "String", "6-1": "String", "7-1": "String", "0-2": "The name of the tool.(ex: MySQL, mongoDB..)", "1-2": "The ID of the tool.", "2-2": "The title of the tool.", "3-2": "The description of the tool.", "4-2": "The website url of the tool.", "5-2": "The image url of the tool.", "6-2": "The url that you can follow the new releases, news and/or so on about the tool.", "7-2": "The canonical path of the tool on StackShare.io(ie: \"/mongodb\").", "0-3": "Yes", "1-3": "Yes", "2-3": "Yes", "3-3": "Yes", "4-3": "Yes", "5-3": "Yes", "6-3": "Yes", "7-3": "Yes" }, "cols": 4, "rows": 8 } [/block]
{"_id":"5dcbe3f26f139a001aea4f4b","project":"55c53c0e5c5d9f0d004969ac","version":"55c53c0f5c5d9f0d004969af","category":"5dcba0186f139a001aea4ab7","user":"5dcad2498884930395855d62","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-11-13T11:07:30.638Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"[block:api-header]\n{\n  \"title\": \"sourceSummary\"\n}\n[/block]\nThis is a hash object that how many of sources have seen for a specific tool.\n\n**Sample Response** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"sourceSummary\\\": {\\n  \\\"dnsRecords\\\": 4,\\n  \\\"cloudIps\\\": 51,\\n  \\\"selfReported\\\": 1,\\n  \\\"githubRepositories\\\": 2,\\n  \\\"websiteSources\\\": 3\\n}\\n\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Sources\"\n}\n[/block]\n\n**website_source**: This field indicates that the tool has been detected on this website. The attributes are domain and last_detected_at(date).\n\n**Sample Response** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"websiteSource\\\": [\\n    {\\n      \\\"domain\\\": \\\"kokoasis.com\\\",\\n      \\\"lastDetectedAt\\\": \\\"2019-10-21\\\",\\n      \\\"confidence\\\": 100\\n    },\\n    {\\n      \\\"domain\\\": \\\"abnb.me\\\",\\n      \\\"lastDetectedAt\\\": \\\"2019-10-20\\\",\\n      \\\"confidence\\\": 100\\n    },\\n    {\\n      \\\"domain\\\": \\\"ar.airbnb.com\\\",\\n      \\\"lastDetectedAt\\\": \\\"2019-10-19\\\",\\n      \\\"confidence\\\": 100\\n    }\\n  ]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n**github_repository**:  This tool has been detected on this repository(repo, name). The attributes are repo_name, link(the link of repository), files(where the tool is detected at), last_detected_at(date), confidence(%) and language_detected(if language detection happened over repository).\n\n**Sample Response** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"githubRepository\\\": [\\n    {\\n      \\\"repo_name\\\": \\\"amazon-kinesis-video-streams-parser-library\\\",\\n      \\\"link\\\": \\\"https://github.com/aws/amazon-kinesis-video-streams-parser-library\\\",\\n      \\\"files\\\": [],\\n      \\\"lastDetectedAt\\\": \\\"2019-10-25\\\",\\n      \\\"confidence\\\": 100,\\n      \\\"languageDetected\\\": true\\n    },\\n    {\\n      \\\"repoName\\\": \\\"amazon-neptune-gremlin-java-sigv4\\\",\\n      \\\"link\\\": \\\"https://github.com/aws/amazon-neptune-gremlin-java-sigv4\\\",\\n      \\\"files\\\": [],\\n      \\\"lastDetectedAt\\\": \\\"2019-10-25\\\",\\n      \\\"confidence\\\": 100,\\n      \\\"languageDetected\\\": true\\n    }\\n  ]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n**dns_records**: Our crawlers work on the dns records for the tools. When a tool is detected on the dns record, they create the source for the tool and named as dns_records. This is what we mean by DNS records. More information can be found on [Wikipedia](https://en.wikipedia.org/wiki/List_of_DNS_record_types)\n\n**Sample Response**\n\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"dnsRecords\\\": [\\n    {\\n      \\\"domain\\\": \\\"abnb.me\\\",\\n      \\\"last_detected_at\\\": \\\"2019-10-20\\\",\\n      \\\"confidence\\\": 100\\n    },\\n    {\\n      \\\"domain\\\": \\\"abnb.me\\\",\\n      \\\"last_detected_at\\\": \\\"2019-10-20\\\",\\n      \\\"confidence\\\": 100\\n    },\\n    {\\n      \\\"domain\\\": \\\"abnb.me\\\",\\n      \\\"last_detected_at\\\": \\\"2019-10-20\\\",\\n      \\\"confidence\\\": 100\\n    },\\n    {\\n      \\\"domain\\\": \\\"abnb.me\\\",\\n      \\\"last_detected_at\\\": \\\"2019-10-20\\\",\\n      \\\"confidence\\\": 100\\n    }\\n  ]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n**cloud_ip**: We have detected that company use the services as third party and seen the third parties ip on them. The attributes are domain, last_detected_at(date) and confidence(%).\n\n**Sample Response** \n\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"cloud_ip\\\": [\\n    {\\n      \\\"domain\\\": \\\"abnb.me\\\",\\n      \\\"last_detected_at\\\": \\\"2019-10-20\\\",\\n      \\\"confidence\\\": 100\\n    },\\n    {\\n      \\\"domain\\\": \\\"airbnb.com\\\",\\n      \\\"last_detected_at\\\": \\\"2019-10-19\\\",\\n      \\\"confidence\\\": 100\\n    },\\n    {\\n      \\\"domain\\\": \\\"next-branch.airbnb.com\\\",\\n      \\\"last_detected_at\\\": \\\"2019-10-19\\\",\\n      \\\"confidence\\\": 100\\n    },\\n    {\\n      \\\"domain\\\": \\\"admin.airbnb.com\\\",\\n      \\\"last_detected_at\\\": \\\"2019-10-19\\\",\\n      \\\"confidence\\\": 100\\n    }\\n  ]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n**mx_records**: Our crawlers actively work on MX Records. When they detect the tool using those, they created the usage report and named as mx_records.  The attributes are domain(the domain of the website), last_detected_at(date) and confidence(%). The more information about MX Records can be found on [Wikipedia](https://en.wikipedia.org/wiki/MX_record)\n\n**Sample Response** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"mx_records\\\": [\\n    {\\n      \\\"domain\\\": \\\"airbnb.com\\\",\\n      \\\"last_detected_at\\\": \\\"2019-10-19\\\",\\n      \\\"confidence\\\": 100\\n    },\\n    {\\n      \\\"domain\\\": \\\"airbnb.com\\\",\\n      \\\"last_detected_at\\\": \\\"2019-10-19\\\",\\n      \\\"confidence\\\": 100\\n    },\\n    {\\n      \\\"domain\\\": \\\"airbnb.com\\\",\\n      \\\"last_detected_at\\\": \\\"2019-10-19\\\",\\n      \\\"confidence\\\": 100\\n    }\\n  ]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n**self_reported**: The employees of the company has claimed the usage. The attributes are last_detected_at(date) and confidence(%).\n\n\n**Sample Response** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"self_reported\\\": [\\n    {\\n      \\\"last_reported_at\\\": \\\"2014-04-26\\\",\\n      \\\"confidence\\\": 100\\n    },\\n    {\\n      \\\"last_reported_at\\\": \\\"2014-10-08\\\",\\n      \\\"confidence\\\": 100\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"The explanation of source types with some examples and the sourceSummary explanation with an example.","slug":"sources-and-sourcesummary","type":"basic","title":"Explanation: Sources and sourceSummary","__v":0,"parentDoc":null,"childrenPages":[]}

Explanation: Sources and sourceSummary

The explanation of source types with some examples and the sourceSummary explanation with an example.

[block:api-header] { "title": "sourceSummary" } [/block] This is a hash object that how many of sources have seen for a specific tool. **Sample Response** [block:code] { "codes": [ { "code": "\"sourceSummary\": {\n \"dnsRecords\": 4,\n \"cloudIps\": 51,\n \"selfReported\": 1,\n \"githubRepositories\": 2,\n \"websiteSources\": 3\n}\n", "language": "json" } ] } [/block] [block:api-header] { "title": "Sources" } [/block] **website_source**: This field indicates that the tool has been detected on this website. The attributes are domain and last_detected_at(date). **Sample Response** [block:code] { "codes": [ { "code": "\"websiteSource\": [\n {\n \"domain\": \"kokoasis.com\",\n \"lastDetectedAt\": \"2019-10-21\",\n \"confidence\": 100\n },\n {\n \"domain\": \"abnb.me\",\n \"lastDetectedAt\": \"2019-10-20\",\n \"confidence\": 100\n },\n {\n \"domain\": \"ar.airbnb.com\",\n \"lastDetectedAt\": \"2019-10-19\",\n \"confidence\": 100\n }\n ]", "language": "json" } ] } [/block] **github_repository**: This tool has been detected on this repository(repo, name). The attributes are repo_name, link(the link of repository), files(where the tool is detected at), last_detected_at(date), confidence(%) and language_detected(if language detection happened over repository). **Sample Response** [block:code] { "codes": [ { "code": "\"githubRepository\": [\n {\n \"repo_name\": \"amazon-kinesis-video-streams-parser-library\",\n \"link\": \"https://github.com/aws/amazon-kinesis-video-streams-parser-library\",\n \"files\": [],\n \"lastDetectedAt\": \"2019-10-25\",\n \"confidence\": 100,\n \"languageDetected\": true\n },\n {\n \"repoName\": \"amazon-neptune-gremlin-java-sigv4\",\n \"link\": \"https://github.com/aws/amazon-neptune-gremlin-java-sigv4\",\n \"files\": [],\n \"lastDetectedAt\": \"2019-10-25\",\n \"confidence\": 100,\n \"languageDetected\": true\n }\n ]", "language": "json" } ] } [/block] **dns_records**: Our crawlers work on the dns records for the tools. When a tool is detected on the dns record, they create the source for the tool and named as dns_records. This is what we mean by DNS records. More information can be found on [Wikipedia](https://en.wikipedia.org/wiki/List_of_DNS_record_types) **Sample Response** [block:code] { "codes": [ { "code": "\"dnsRecords\": [\n {\n \"domain\": \"abnb.me\",\n \"last_detected_at\": \"2019-10-20\",\n \"confidence\": 100\n },\n {\n \"domain\": \"abnb.me\",\n \"last_detected_at\": \"2019-10-20\",\n \"confidence\": 100\n },\n {\n \"domain\": \"abnb.me\",\n \"last_detected_at\": \"2019-10-20\",\n \"confidence\": 100\n },\n {\n \"domain\": \"abnb.me\",\n \"last_detected_at\": \"2019-10-20\",\n \"confidence\": 100\n }\n ]", "language": "json" } ] } [/block] **cloud_ip**: We have detected that company use the services as third party and seen the third parties ip on them. The attributes are domain, last_detected_at(date) and confidence(%). **Sample Response** [block:code] { "codes": [ { "code": "\"cloud_ip\": [\n {\n \"domain\": \"abnb.me\",\n \"last_detected_at\": \"2019-10-20\",\n \"confidence\": 100\n },\n {\n \"domain\": \"airbnb.com\",\n \"last_detected_at\": \"2019-10-19\",\n \"confidence\": 100\n },\n {\n \"domain\": \"next-branch.airbnb.com\",\n \"last_detected_at\": \"2019-10-19\",\n \"confidence\": 100\n },\n {\n \"domain\": \"admin.airbnb.com\",\n \"last_detected_at\": \"2019-10-19\",\n \"confidence\": 100\n }\n ]", "language": "json" } ] } [/block] **mx_records**: Our crawlers actively work on MX Records. When they detect the tool using those, they created the usage report and named as mx_records. The attributes are domain(the domain of the website), last_detected_at(date) and confidence(%). The more information about MX Records can be found on [Wikipedia](https://en.wikipedia.org/wiki/MX_record) **Sample Response** [block:code] { "codes": [ { "code": "\"mx_records\": [\n {\n \"domain\": \"airbnb.com\",\n \"last_detected_at\": \"2019-10-19\",\n \"confidence\": 100\n },\n {\n \"domain\": \"airbnb.com\",\n \"last_detected_at\": \"2019-10-19\",\n \"confidence\": 100\n },\n {\n \"domain\": \"airbnb.com\",\n \"last_detected_at\": \"2019-10-19\",\n \"confidence\": 100\n }\n ]", "language": "json" } ] } [/block] **self_reported**: The employees of the company has claimed the usage. The attributes are last_detected_at(date) and confidence(%). **Sample Response** [block:code] { "codes": [ { "code": "\"self_reported\": [\n {\n \"last_reported_at\": \"2014-04-26\",\n \"confidence\": 100\n },\n {\n \"last_reported_at\": \"2014-10-08\",\n \"confidence\": 100\n }\n ]\n}", "language": "json" } ] } [/block]
[block:api-header] { "title": "sourceSummary" } [/block] This is a hash object that how many of sources have seen for a specific tool. **Sample Response** [block:code] { "codes": [ { "code": "\"sourceSummary\": {\n \"dnsRecords\": 4,\n \"cloudIps\": 51,\n \"selfReported\": 1,\n \"githubRepositories\": 2,\n \"websiteSources\": 3\n}\n", "language": "json" } ] } [/block] [block:api-header] { "title": "Sources" } [/block] **website_source**: This field indicates that the tool has been detected on this website. The attributes are domain and last_detected_at(date). **Sample Response** [block:code] { "codes": [ { "code": "\"websiteSource\": [\n {\n \"domain\": \"kokoasis.com\",\n \"lastDetectedAt\": \"2019-10-21\",\n \"confidence\": 100\n },\n {\n \"domain\": \"abnb.me\",\n \"lastDetectedAt\": \"2019-10-20\",\n \"confidence\": 100\n },\n {\n \"domain\": \"ar.airbnb.com\",\n \"lastDetectedAt\": \"2019-10-19\",\n \"confidence\": 100\n }\n ]", "language": "json" } ] } [/block] **github_repository**: This tool has been detected on this repository(repo, name). The attributes are repo_name, link(the link of repository), files(where the tool is detected at), last_detected_at(date), confidence(%) and language_detected(if language detection happened over repository). **Sample Response** [block:code] { "codes": [ { "code": "\"githubRepository\": [\n {\n \"repo_name\": \"amazon-kinesis-video-streams-parser-library\",\n \"link\": \"https://github.com/aws/amazon-kinesis-video-streams-parser-library\",\n \"files\": [],\n \"lastDetectedAt\": \"2019-10-25\",\n \"confidence\": 100,\n \"languageDetected\": true\n },\n {\n \"repoName\": \"amazon-neptune-gremlin-java-sigv4\",\n \"link\": \"https://github.com/aws/amazon-neptune-gremlin-java-sigv4\",\n \"files\": [],\n \"lastDetectedAt\": \"2019-10-25\",\n \"confidence\": 100,\n \"languageDetected\": true\n }\n ]", "language": "json" } ] } [/block] **dns_records**: Our crawlers work on the dns records for the tools. When a tool is detected on the dns record, they create the source for the tool and named as dns_records. This is what we mean by DNS records. More information can be found on [Wikipedia](https://en.wikipedia.org/wiki/List_of_DNS_record_types) **Sample Response** [block:code] { "codes": [ { "code": "\"dnsRecords\": [\n {\n \"domain\": \"abnb.me\",\n \"last_detected_at\": \"2019-10-20\",\n \"confidence\": 100\n },\n {\n \"domain\": \"abnb.me\",\n \"last_detected_at\": \"2019-10-20\",\n \"confidence\": 100\n },\n {\n \"domain\": \"abnb.me\",\n \"last_detected_at\": \"2019-10-20\",\n \"confidence\": 100\n },\n {\n \"domain\": \"abnb.me\",\n \"last_detected_at\": \"2019-10-20\",\n \"confidence\": 100\n }\n ]", "language": "json" } ] } [/block] **cloud_ip**: We have detected that company use the services as third party and seen the third parties ip on them. The attributes are domain, last_detected_at(date) and confidence(%). **Sample Response** [block:code] { "codes": [ { "code": "\"cloud_ip\": [\n {\n \"domain\": \"abnb.me\",\n \"last_detected_at\": \"2019-10-20\",\n \"confidence\": 100\n },\n {\n \"domain\": \"airbnb.com\",\n \"last_detected_at\": \"2019-10-19\",\n \"confidence\": 100\n },\n {\n \"domain\": \"next-branch.airbnb.com\",\n \"last_detected_at\": \"2019-10-19\",\n \"confidence\": 100\n },\n {\n \"domain\": \"admin.airbnb.com\",\n \"last_detected_at\": \"2019-10-19\",\n \"confidence\": 100\n }\n ]", "language": "json" } ] } [/block] **mx_records**: Our crawlers actively work on MX Records. When they detect the tool using those, they created the usage report and named as mx_records. The attributes are domain(the domain of the website), last_detected_at(date) and confidence(%). The more information about MX Records can be found on [Wikipedia](https://en.wikipedia.org/wiki/MX_record) **Sample Response** [block:code] { "codes": [ { "code": "\"mx_records\": [\n {\n \"domain\": \"airbnb.com\",\n \"last_detected_at\": \"2019-10-19\",\n \"confidence\": 100\n },\n {\n \"domain\": \"airbnb.com\",\n \"last_detected_at\": \"2019-10-19\",\n \"confidence\": 100\n },\n {\n \"domain\": \"airbnb.com\",\n \"last_detected_at\": \"2019-10-19\",\n \"confidence\": 100\n }\n ]", "language": "json" } ] } [/block] **self_reported**: The employees of the company has claimed the usage. The attributes are last_detected_at(date) and confidence(%). **Sample Response** [block:code] { "codes": [ { "code": "\"self_reported\": [\n {\n \"last_reported_at\": \"2014-04-26\",\n \"confidence\": 100\n },\n {\n \"last_reported_at\": \"2014-10-08\",\n \"confidence\": 100\n }\n ]\n}", "language": "json" } ] } [/block]