openapi: 3.0.2 info: title: Wordtracker Keyword API version: '3.0' description: > *First release: 06.06.22, last API release: 06.06.22, last API docs release: 13.03.25* ## Introduction ### Google keywords with raw clickstream for more accurate search volumes The `Wordtracker Keyword API 3.0` provides keywords and associated search volumes for Google. This data comes from Google and the [clickstream](https://www.wordtracker.com/blog/keyword-research/what-is-clickstream-data), which makes it a very reliable, clean source of keywords (upwards of 2.06 billion unique keywords from 5.5 billion searches). To use the API you will first need to [sign up here](https://wordtracker.3scale.net). For pricing and more general information, please take a [look here](https://www.wordtracker.com/api). Please note that this is v3.0 of the Wordtracker Keyword API and currently includes keywords and search volumes from: - Google We have search volumes for 240 countries. For the full list please see this spreadsheet [Wordtracker keyword API | Countries](https://docs.google.com/spreadsheets/d/1GCMXn_l4K5QYg8ijj9Asb9iPtvaep1TmAL2MKwhQIIw/edit#gid=267834601). ## Get going in 10 minutes! First [register for an API account](https://wordtracker.3scale.net) (30 day free trial available). You can then find the production ready Wordtracker Keyword API 3.0 server at: https://api.wordtracker.com Please make sure you add the `app_id` and `app_key` as authorisation. Here's an example [REST url](https://api.wordtracker.com/v3/keywords/search?engine=google&country=us&seeds=dog&limit=10&type=broad&app_id=your_app_id&app_key=your_key) to query the /search method. Please note: If the above url does not work, please check the version e.g. /v3. You can also see the latest calls at https://api.wordtracker.com. ### Please choose from these options * [Register for an API account (30 day free trial available)](https://wordtracker.3scale.net) * [API pricing](http://www.wordtracker.com/api) * [Try the data out in the Wordtracker keyword tool](http://www.wordtracker.com) ## Available metrics ### Majestic SEO link counts Wordtracker have partnered with [MajesticSEO](http://www.majestic.com) who have the planet's largest Link Index database. Our 'global Google' keyword list has been matched against Majestic's database to allow you to see how much competition there is online for a given keyword. Keywords with high search volumes and a low link footprint present good SEO opportunities. Note: These metrics cover both 'on page' (title tag) and 'off page' (incoming links). If the 'majestic' parameter is set to True, the following additional [MajesticSEO](http://www.majestic.com) link count metrics are available: 1. **exact_urls_in_title:** Number of URLs that contain the exact keyword phrase within the title tag. E.g. for the keyword 'dog training' this would match 'dog training' and 'i love dog training' but not 'training my dog'. 2. **exact_domains_in_title:** Number of unique root domains (not URLs) that contain the exact keyword phrase within the title tag. 3. **exact_urls_in_url**: Number of URLs that contain the exact keyword phrase within the URL. E.g. for the keyword 'dog training', this would match http://www.domain.com/dog-training-is-cool.html or http://www.dog-training.com. 4. **exact_domains_in_url**: Number of unique root domains (not URLs) that contain the exact keyword phrase in the url belonging to that root domain. 5. **exact_urls_in_anchor**: Number of URLs that contain the exact keyword phrase within the external anchor text of at least one backlink. 6. **exact_domains_in_anchor**: Number of root domains (not URLs) that contain the exact keyword phrase within the external anchor text of at least one backlink. 7. **exact_urls_in_anchor_and_in_title**: Number of URLs that contain the exact keyword phrase within both within the title tag & also in the external anchor text of at least one backlink. 8. **exact_domains_in_anchor_and_in_title**: Number of root domains (not URLs) that contain the exact keyword phrase within both the external anchor text of at least one backlink and within the title tag. 9. **broad_urls_in_title**: Number of URLs that contain all the words in any order within the title tag. E.g. for the keyword 'dog training' this would match 'training my dog'. 10. **broad_domains_in_title**: Number of unique root domains (not URLs) that contain all the words in any order within the title tag. 11. **broad_urls_in_anchor**: Number of URLs that contain all the words in any order in the external anchor text of at least one backlink. 12. **broad_domains_in_anchor**: Number of root domains (not URLs) that contain all the words in any order within the external anchor text of at least one backlink. 13. **broad_urls_in_anchor_and_in_title**: Number of URLs that contain all the words in any order, both within the title tag & also in the external anchor text of at least one backlink. 14. **broad_domains_in_anchor_and_in_title**: Number of root domains (not URLs) that contain all the words in any order within the external anchor text of at least one backlink and the title tag. ## Releases - **3.0.0**: 06.07.22: First release of Wordtracker Keyword API 3.0. termsOfService: 'https://www.wordtracker.com/terms' contact: name: Wordtracker API Team url: 'http://www.wordtracker.com' email: devops@wordtracker.com license: name: Apache 2.0 url: 'https://www.apache.org/licenses/LICENSE-2.0.html' x-date: '2022-06-07' x-logo: url: 'https://s3.amazonaws.com/wordtracker-front-end-assets/images/wordtracker-logo-transparent.png' backgroundColor: '#5195E9' servers: - url: 'https://api.wordtracker.com/v3' description: Production server paths: /search: get: responses: '200': content: application/json: examples: firefox: value: results: - keyword: firefox total_volume: 25258 avg_volume: 2105 volume_by_month: - volume: 2336 year: '2019' month: 09 - volume: 2486 year: '2019' month: '10' - volume: 2410 year: '2019' month: '11' - ... total_months_seen: 12 - keyword: mozilla firefox total_volume: 4013 avg_volume: 334 volume_by_month: - volume: 476 year: '2019' month: 09 - volume: 424 year: '2019' month: '10' - volume: 373 year: '2019' month: '11' - ... total_months_seen: 12 params: engine: google country_code: us seeds: - firefox limit: 10 type: broad sort: total stats: possible_results: 19264 results: 100 elapsed: 0.0571s description: >- Monthly search volume for one or more specific seed terms for a search engine with a country_code e.g. Google US. Also includes total volume, average volume for last 12 months, total months seen and the query parameters. Takes up to 200 seeds and returns up to 800 keyword ideas. '401': $ref: '#/components/responses/AccessForbidden' '404': $ref: '#/components/responses/NotFound' operationId: search summary: /search description: > Search the Wordtracker Keyword API for Google keyword suggestions and monthly volumes using one or more seed terms. Note: We use the clickstream data to break apart keywords with the same search volumes to find a more accurate traffic estimate. parameters: - $ref: '#/components/parameters/seeds' - $ref: '#/components/parameters/engine' - $ref: '#/components/parameters/country_code' - $ref: '#/components/parameters/type' - $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/start' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/majestic' /fetch: post: responses: '200': content: application/json: examples: firefox: value: results: - keyword: hello world total_volume: 984 avg_volume: 82 volume_by_month: - volume: 93 year: '2019' month: 09 - volume: 89 year: '2019' month: '10' - volume: 113 year: '2019' month: '11' - ... total_months_seen: 12 params: engine: google country_code: us seeds: hello world type: exact sort: total stats: possible_results: 10 results: 10 elapsed: 0.0571s description: >- Monthly search volume for one or more specific seed terms for an engine and a country_code e.g. Google US. Also includes total volume, average volume for last 12 months, total months seen and the query parameters. '401': $ref: '#/components/responses/AccessForbidden' '404': $ref: '#/components/responses/NotFound' operationId: fetch summary: /fetch description: >- Whereas /search takes up to 200 seeds and returns up to 800 keyword suggestions, /fetch is more specific. This method allows you to enter up to 700 seeds and retrieve the search volume (and panelist volumes) for each of those seeds specifically. Note: We use the clickstream data to break apart keywords with the same search volumes to find a more accurate traffic estimate. parameters: - $ref: '#/components/parameters/seeds' - $ref: '#/components/parameters/engine' - $ref: '#/components/parameters/country_code' - $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/majestic' components: schemas: Error: type: object properties: status: description: The HTTP status code. maximum: 600 minimum: 100 type: integer error: type: string type: description: >- A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". type: string title: description: >- A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. type: string responses: AccessForbidden: content: application/json: schema: $ref: '#/components/schemas/Error' description: 'Access forbidden, invalid API key was used' NotFound: content: application/json: schema: $ref: '#/components/schemas/Error' description: Resource was not found parameters: seeds: name: seeds description: >- One or more strings. If entering a single seed then simply specify seeds=dog and if multiple then please use a list format e.g. seeds='dog','dog training'. Think of `seeds` as one or more of your starter ideas to get going with e.g. 'chocolate' or 'dog training'. This is a separate concept from keywords which are returned in the results and which show exactly what people are typing into the search boxes of the engines like Google. With some analysis some of these results will become your key words aka `keywords`. schema: type: array items: {} in: query required: true engine: name: engine description: 'The engine that you want keyword suggestions and monthly volumes for. Default: `google`.' schema: enum: - google in: query required: true country_code: name: country_code description: >- Specifies the territory to search within. Please use a two letter ISO 3166-2 country code. e.g. `US` is United States and `GB` is Great Britain (United Kingdom). Default: `US`. schema: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IN - IO - IQ - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - ST - SV - SX - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW in: query required: true type: name: type description: >- ### Broad Returns keyword suggestions for all words in any order. E.g. a search for 'dog training' returns: * dog training * training your dog but not: * every dog has it's day schema: enum: - broad in: query required: true sort: name: sort description: >- How you'd like to sort the results. Default `total`. Total: Total searches for the last 12 months which means total search volume for Jan + Feb + Mar etc. Avg: Average searches for the last 12 months which means the total search volume for all 12 months / 12. schema: enum: - total - avg in: query required: true start: name: start description: |- Which row would you like results to be returned from. An integer between 1 (min) and 2000 max results in the query. Please make sure that `start` + `limit` <= 2000. schema: type: integer in: query required: true limit: name: limit description: |- The maximum number of results which will be returned from the query. An integer between 1 and 2000 (max). schema: type: integer in: query required: true majestic: name: majestic description: Add Majestic (www.majestic.com) link count metrics. schema: type: boolean in: query required: true volume: name: volume description: >- Which volume to use for the last 12 months. I.e. the `total` for the last 12 months or the average (`avg`). schema: enum: - total - avg in: query required: true securitySchemes: app_key: type: apiKey description: >- The Wordtracker Keyword API requires the `app_id` and `app_key` parameters in order to perform authorization. Authentication parameters must be present in the query string only, regardless of request method. To obtain these please sign up at https://wordtracker.3scale.net name: app_key in: header app_id: type: apiKey description: >- The Wordtracker Keyword API requires the `app_id` and `app_key` parameters in order to perform authorization. Authentication parameters must be present in the query string only, regardless of request method. To obtain these please sign up at https://wordtracker.3scale.net name: app_id in: header security: - app_key: [] app_id: []