├── CHANGELOG.md ├── composer.json ├── package.json ├── LICENSE.md ├── README.md └── src ├── price_estimation.json ├── product_store.json └── pcdomains.json /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "internetx/internetx-swagger-files", 3 | "description": "All the files needed to interact with the InterNetX APIs. The files help to create documentation and models matching the API.", 4 | "type": "library", 5 | "license": "MIT", 6 | "autoload": { 7 | "psr-4": { 8 | "IXSwagger\\": "src/" 9 | } 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "1.0.0", 3 | "name": "@internetx/internetx-swagger-files", 4 | "description": "All the files needed to interact with the InterNetX APIs. The files help to create documentation and models matching the API.", 5 | "license": "MIT", 6 | "author": "InterNetX GmbH ", 7 | "homepage": "https://www.internetx.com", 8 | "repository": "https: //github.com/adelholtz/domainrobot-api.git" 9 | } -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2018 InterNetX - official 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Domainrobot Api 2 | 3 | The *Domainrobot API* is a powerful, professional API for managing domains, certificates, dns and much more. The API can be accessed via three different interfaces : 4 | 5 | * JSON 6 | * XML 7 | * EPP 8 | 9 | ## Table of Contents 10 | 11 | 1. [Domainrobot JSON API](#domainrobot-json-api) 12 | * [Domainrobot SDKs](#domainrobot-sdks) 13 | * [JSON Documentation](#documentation) 14 | * [Open API](#open-api) 15 | 2. [Domainrobot XML API](#domainrobot-xml-api) 16 | * [XML Documentation](#documentation) 17 | 3. [Domainrobot EPP API](#domainrobot-epp-api) 18 | * [EPP Documentation](#documentation) 19 | 4. [Changelog](#changelog) 20 | 5. [License](#license) 21 | 22 | ## Domainrobot JSON API 23 | 24 | The JSON API represents the latest development of the Domainrobot API including all new features like the DomainStudio. 25 | 26 | ### Domainrobot SDKs 27 | 28 | Several Software Development Kit's (SDK's) are available for implementing the JSON API. 29 | 30 | * Java: 31 | * Php: 32 | * Dart: 33 | * Js: 34 | 35 | ### Documentation 36 | 37 | A full documentation about the API can be found at . 38 | 39 | ### Open API 40 | 41 | There is also a [specification](/src/domainrobot.json) available for the JSON API using the Open API V2 standard. 42 | 43 | ## Domainrobot XML API 44 | 45 | The legacy way to access the Domainrobot API. 46 | 47 | ### Documentation 48 | 49 | A full documentation about the API can be found at . 50 | 51 | ## Domainrobot EPP API 52 | 53 | The EPP API allows you to interact with the Domainrobot API using EPP syntax. The API is compatible with [RFC 5731](https://tools.ietf.org/html/rfc5731). 54 | 55 | ### Documentation 56 | 57 | A full documentation about the API can be found at . 58 | 59 | ## Changelog 60 | 61 | For a detailed changelog, see the [CHANGELOG.md](CHANGELOG.md) file 62 | 63 | ## License 64 | 65 | This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details 66 | -------------------------------------------------------------------------------- /src/price_estimation.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "description": "The documentation for the price estimation API by InterNetX GmbH.", 5 | "version": "1.0.0", 6 | "title": "Price Estimation API" 7 | }, 8 | "host": "pc.domains", 9 | "basePath": "/api", 10 | "tags": [ 11 | { 12 | "name": "estimation", 13 | "description": "Estimate the value for domains" 14 | } 15 | ], 16 | "schemes": [ 17 | "https" 18 | ], 19 | "paths": { 20 | "/estimation/{domain}": { 21 | "get": { 22 | "tags": [ 23 | "estimation" 24 | ], 25 | "summary": "Estimate the value for the given domain", 26 | "description": "Estimate the value for the given domain", 27 | "produces": [ 28 | "application/json" 29 | ], 30 | "parameters": [ 31 | { 32 | "name": "domain", 33 | "in": "path", 34 | "description": "The domain name for the estimation", 35 | "required": true, 36 | "type": "string" 37 | } 38 | ], 39 | "responses": { 40 | "200": { 41 | "description": "successful operation", 42 | "schema": { 43 | "$ref": "#/definitions/ApiResponse" 44 | } 45 | } 46 | }, 47 | "security": [ 48 | { 49 | "Bearer": [] 50 | } 51 | ] 52 | } 53 | } 54 | }, 55 | "securityDefinitions": { 56 | "Bearer": { 57 | "type": "apiKey", 58 | "name": "Authorization", 59 | "in": "header" 60 | } 61 | }, 62 | "definitions": { 63 | "ApiResponse": { 64 | "type": "object", 65 | "properties": { 66 | "status": { 67 | "$ref": "#/definitions/ApiResponseStatus" 68 | }, 69 | "object": { 70 | "$ref": "#/definitions/ApiResponseObject" 71 | }, 72 | "data": { 73 | "type": "array", 74 | "items": { 75 | "$ref": "#/definitions/Estimation" 76 | } 77 | } 78 | } 79 | }, 80 | "ApiResponseStatus": { 81 | "type": "object", 82 | "properties": { 83 | "code": { 84 | "type": "string" 85 | }, 86 | "text": { 87 | "type": "string" 88 | }, 89 | "type": { 90 | "type": "string" 91 | } 92 | } 93 | }, 94 | "ApiResponseObject": { 95 | "type": "object", 96 | "properties": { 97 | "type": { 98 | "type": "string" 99 | }, 100 | "value": { 101 | "type": "string" 102 | } 103 | } 104 | }, 105 | "Estimation": { 106 | "type": "object", 107 | "properties": { 108 | "domain": { 109 | "type": "string" 110 | }, 111 | "estimation": { 112 | "type": "number", 113 | "format": "double" 114 | }, 115 | "quantity": { 116 | "type": "integer", 117 | "format": "int32" 118 | }, 119 | "parameters": { 120 | "$ref": "#/definitions/EstimationParameters" 121 | }, 122 | "similarDomains": { 123 | "type": "array", 124 | "items": { 125 | "$ref": "#/definitions/SimilarDomain" 126 | } 127 | } 128 | } 129 | }, 130 | "EstimationParameters": { 131 | "type": "object", 132 | "properties": { 133 | "averageKeywordFrequency": { 134 | "type": "string" 135 | }, 136 | "averageKeywordPrice": { 137 | "type": "string" 138 | }, 139 | "averageLengthFrequency": { 140 | "type": "string" 141 | }, 142 | "averageLengthPrice": { 143 | "type": "string" 144 | }, 145 | "averageTldFrequency": { 146 | "type": "string" 147 | }, 148 | "averageTldPrice": { 149 | "type": "string" 150 | }, 151 | "char": { 152 | "type": "string" 153 | }, 154 | "comDomain": { 155 | "type": "string" 156 | }, 157 | "completelyNum": { 158 | "type": "string" 159 | }, 160 | "foundKeywords": { 161 | "type": "string" 162 | }, 163 | "foundPrefix": { 164 | "type": "string" 165 | }, 166 | "foundSuffix": { 167 | "type": "string" 168 | }, 169 | "hyph": { 170 | "type": "string" 171 | }, 172 | "idnEncoding": { 173 | "type": "string" 174 | }, 175 | "keywordCount": { 176 | "type": "string" 177 | }, 178 | "majesticsGlobalRank": { 179 | "type": "string" 180 | }, 181 | "majesticsPrevGlobalRank": { 182 | "type": "string" 183 | }, 184 | "majesticsPrevRefIPs": { 185 | "type": "string" 186 | }, 187 | "majesticsPrevRefSubNets": { 188 | "type": "string" 189 | }, 190 | "majesticsPrevTldRank": { 191 | "type": "string" 192 | }, 193 | "majesticsRefIPs": { 194 | "type": "string" 195 | }, 196 | "majesticsRefSubNets": { 197 | "type": "string" 198 | }, 199 | "majesticsTldRank": { 200 | "type": "string" 201 | }, 202 | "nameSeg": { 203 | "type": "string" 204 | }, 205 | "num": { 206 | "type": "string" 207 | }, 208 | "numWords": { 209 | "type": "string" 210 | }, 211 | "tld": { 212 | "type": "string" 213 | }, 214 | "tldNumDomains": { 215 | "type": "string" 216 | } 217 | } 218 | }, 219 | "SimilarDomain": { 220 | "type": "object", 221 | "properties": { 222 | "relatedDomainPrice": { 223 | "type": "number", 224 | "format": "double" 225 | }, 226 | "relatedDomains": { 227 | "type": "string" 228 | } 229 | } 230 | } 231 | }, 232 | "externalDocs": { 233 | "description": "Find out more about InterNetX API(s).", 234 | "url": "http://help.internetx.com" 235 | } 236 | } 237 | -------------------------------------------------------------------------------- /src/product_store.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "title": "Domainrobot Productstore Json API", 5 | "description": "Central api that provides information about the products offered by InterNetX", 6 | "version": "1.0.0" 7 | }, 8 | "basePath": "/v1", 9 | "produces": [ 10 | "application/json" 11 | ], 12 | "paths": { 13 | "/ssl": { 14 | "get": { 15 | "summary": "List ssl products", 16 | "description": "Returns a list of all ssl products", 17 | "parameters": [ 18 | { 19 | "name": "keyword", 20 | "in": "query", 21 | "description": "The product to search for", 22 | "required": false, 23 | "type": "string" 24 | } 25 | ], 26 | "consumes": [ 27 | "application/json" 28 | ], 29 | "produces": [ 30 | "application/json" 31 | ], 32 | "responses": { 33 | "200": { 34 | "description": "An array of products", 35 | "schema": { 36 | "$ref": "#/definitions/SslProductsResponse" 37 | } 38 | } 39 | } 40 | } 41 | }, 42 | "/ssl/_paginate": { 43 | "get": { 44 | "summary": "Paginate ssl products", 45 | "description": "Returns a list of all ssl products as a pagination object", 46 | "consumes": [ 47 | "application/json" 48 | ], 49 | "produces": [ 50 | "application/json" 51 | ], 52 | "responses": { 53 | "200": { 54 | "description": "successful operation", 55 | "schema": { 56 | "$ref": "#/definitions/SslProductPagination" 57 | } 58 | } 59 | } 60 | } 61 | }, 62 | "/ssl/{label}": { 63 | "get": { 64 | "summary": "Show ssl product information.", 65 | "description": "Returns the information belonging to the given product.", 66 | "consumes": [ 67 | "application/json" 68 | ], 69 | "produces": [ 70 | "application/json" 71 | ], 72 | "parameters": [ 73 | { 74 | "in": "path", 75 | "name": "label", 76 | "description": "The label of the ssl product.", 77 | "required": true, 78 | "type": "string" 79 | } 80 | ], 81 | "responses": { 82 | "200": { 83 | "description": "Product found.", 84 | "schema": { 85 | "$ref": "#/definitions/SslProductResponse" 86 | } 87 | }, 88 | "404": { 89 | "description": "Product not found.", 90 | "schema": { 91 | "$ref": "#/definitions/ErrorResponse" 92 | } 93 | } 94 | } 95 | } 96 | }, 97 | "/tld": { 98 | "get": { 99 | "summary": "List tld products", 100 | "description": "Returns a list of all ssl products", 101 | "parameters": [ 102 | { 103 | "name": "keyword", 104 | "in": "query", 105 | "description": "The product to search for. Can be \"de\" or a comma seperated list like \"de,com,org\". If you search without a list, it will search for the exact match and a wildcard at the beginning and the end of the keyword. For example, if you search for \"de\" you will receive \"de,deals,com.de,de.com\" etc.", 106 | "required": false, 107 | "type": "string" 108 | }, 109 | { 110 | "name": "tldType", 111 | "in": "query", 112 | "description": "The type of the tld. CCTLD / GTLD / NEW_GTLD", 113 | "required": false, 114 | "type": "string" 115 | }, 116 | { 117 | "name": "tldContinent", 118 | "in": "query", 119 | "description": "The contintent of the tld. Only useful for CCTLDs.", 120 | "required": false, 121 | "type": "string" 122 | }, 123 | { 124 | "name": "tldCategory", 125 | "in": "query", 126 | "description": "The category for this tld.", 127 | "required": false, 128 | "type": "string" 129 | }, 130 | { 131 | "name": "tldLanguageOfOffice", 132 | "in": "query", 133 | "description": "The official language of the tld as two letter representation, for example FR for french language. Only useful for CCTLDs.", 134 | "required": false, 135 | "type": "string" 136 | }, 137 | { 138 | "name": "tldGeoPol", 139 | "in": "query", 140 | "description": "A geo / political filter. Only useful for CCTLDs.", 141 | "required": false, 142 | "type": "string" 143 | }, 144 | { 145 | "name": "dnssec", 146 | "in": "query", 147 | "description": "Filter for tlds which support dnssec.", 148 | "required": false, 149 | "type": "boolean" 150 | }, 151 | { 152 | "name": "privacy", 153 | "in": "query", 154 | "description": "Filter for tlds which support privacy.", 155 | "required": false, 156 | "type": "boolean" 157 | }, 158 | { 159 | "name": "thirdlevel", 160 | "in": "query", 161 | "description": "Filter for thirdlevel tlds.", 162 | "required": false, 163 | "type": "boolean" 164 | }, 165 | { 166 | "name": "trustee", 167 | "in": "query", 168 | "description": "Filter for tlds which support trustee.", 169 | "required": false, 170 | "type": "boolean" 171 | }, 172 | { 173 | "name": "premium", 174 | "in": "query", 175 | "description": "Filter for tlds which have premium domains.", 176 | "required": false, 177 | "type": "boolean" 178 | }, 179 | { 180 | "name": "authinfo", 181 | "in": "query", 182 | "description": "Filter for tlds which support authinfo.", 183 | "required": false, 184 | "type": "boolean" 185 | }, 186 | { 187 | "name": "contactExtensions", 188 | "in": "query", 189 | "description": "Filter for tlds which have special contact extensions.", 190 | "required": false, 191 | "type": "boolean" 192 | } 193 | ], 194 | "consumes": [ 195 | "application/json" 196 | ], 197 | "produces": [ 198 | "application/json" 199 | ], 200 | "responses": { 201 | "200": { 202 | "description": "An array of products", 203 | "schema": { 204 | "$ref": "#/definitions/TldProductsResponse" 205 | } 206 | } 207 | } 208 | } 209 | }, 210 | "/tld/_paginate": { 211 | "get": { 212 | "summary": "Paginate tld products", 213 | "description": "Returns a list of all tld products as a pagination object", 214 | "parameters": [ 215 | { 216 | "name": "keyword", 217 | "in": "query", 218 | "description": "The product to search for. Can be \"de\" or a comma seperated list like \"de,com,org\". If you search without a list, it will search for the exact match and a wildcard at the beginning and the end of the keyword. For example, if you search for \"de\" you will receive \"de,deals,com.de,de.com\" etc.", 219 | "required": false, 220 | "type": "string" 221 | }, 222 | { 223 | "name": "tldType", 224 | "in": "query", 225 | "description": "The type of the tld. CCTLD / GTLD / NEW_GTLD", 226 | "required": false, 227 | "type": "string" 228 | }, 229 | { 230 | "name": "tldContinent", 231 | "in": "query", 232 | "description": "The contintent of the tld. Only useful for CCTLDs.", 233 | "required": false, 234 | "type": "string" 235 | }, 236 | { 237 | "name": "tldCategory", 238 | "in": "query", 239 | "description": "The category for this tld.", 240 | "required": false, 241 | "type": "string" 242 | }, 243 | { 244 | "name": "tldLanguageOfOffice", 245 | "in": "query", 246 | "description": "The official language of the tld as two letter representation, for example FR for french language. Only useful for CCTLDs.", 247 | "required": false, 248 | "type": "string" 249 | }, 250 | { 251 | "name": "tldGeoPol", 252 | "in": "query", 253 | "description": "A geo / political filter. Only useful for CCTLDs.", 254 | "required": false, 255 | "type": "string" 256 | }, 257 | { 258 | "name": "dnssec", 259 | "in": "query", 260 | "description": "Filter for tlds which support dnssec.", 261 | "required": false, 262 | "type": "boolean" 263 | }, 264 | { 265 | "name": "privacy", 266 | "in": "query", 267 | "description": "Filter for tlds which support privacy.", 268 | "required": false, 269 | "type": "boolean" 270 | }, 271 | { 272 | "name": "thirdlevel", 273 | "in": "query", 274 | "description": "Filter for thirdlevel tlds.", 275 | "required": false, 276 | "type": "boolean" 277 | }, 278 | { 279 | "name": "trustee", 280 | "in": "query", 281 | "description": "Filter for tlds which support trustee.", 282 | "required": false, 283 | "type": "boolean" 284 | }, 285 | { 286 | "name": "premium", 287 | "in": "query", 288 | "description": "Filter for tlds which have premium domains.", 289 | "required": false, 290 | "type": "boolean" 291 | }, 292 | { 293 | "name": "authinfo", 294 | "in": "query", 295 | "description": "Filter for tlds which support authinfo.", 296 | "required": false, 297 | "type": "boolean" 298 | }, 299 | { 300 | "name": "contactExtensions", 301 | "in": "query", 302 | "description": "Filter for tlds which have special contact extensions.", 303 | "required": false, 304 | "type": "boolean" 305 | } 306 | ], 307 | "consumes": [ 308 | "application/json" 309 | ], 310 | "produces": [ 311 | "application/json" 312 | ], 313 | "responses": { 314 | "200": { 315 | "description": "successful operation", 316 | "schema": { 317 | "$ref": "#/definitions/TldProductPagination" 318 | } 319 | } 320 | } 321 | } 322 | }, 323 | "/tld/{label}": { 324 | "get": { 325 | "summary": "Show tld product information.", 326 | "description": "Returns the information belonging to the given product.", 327 | "consumes": [ 328 | "application/json" 329 | ], 330 | "produces": [ 331 | "application/json" 332 | ], 333 | "parameters": [ 334 | { 335 | "in": "path", 336 | "name": "label", 337 | "description": "The label of the tld product.", 338 | "required": true, 339 | "type": "string" 340 | } 341 | ], 342 | "responses": { 343 | "200": { 344 | "description": "Product found.", 345 | "schema": { 346 | "$ref": "#/definitions/TldProductResponse" 347 | } 348 | }, 349 | "404": { 350 | "description": "Product not found.", 351 | "schema": { 352 | "$ref": "#/definitions/ErrorResponse" 353 | } 354 | } 355 | } 356 | } 357 | } 358 | }, 359 | "definitions": { 360 | "SslProductResponse": { 361 | "type": "object", 362 | "properties": { 363 | "data": { 364 | "$ref": "#/definitions/SslProduct" 365 | } 366 | } 367 | }, 368 | "SslProductsResponse": { 369 | "type": "object", 370 | "properties": { 371 | "data": { 372 | "type": "array", 373 | "items": { 374 | "$ref": "#/definitions/SslProduct" 375 | } 376 | } 377 | } 378 | }, 379 | "SslProduct": { 380 | "type": "object", 381 | "properties": { 382 | "id": { 383 | "type": "integer", 384 | "format": "int32" 385 | }, 386 | "label": { 387 | "type": "string" 388 | }, 389 | "name": { 390 | "type": "string" 391 | }, 392 | "acl": { 393 | "type": "string" 394 | }, 395 | "productCode": { 396 | "type": "string" 397 | }, 398 | "provider": { 399 | "$ref": "#/definitions/SslProductProvider" 400 | }, 401 | "certificateType": { 402 | "$ref": "#/definitions/SslProductCertificateType" 403 | }, 404 | "validationType": { 405 | "$ref": "#/definitions/SslProductValidationType" 406 | }, 407 | "certificateAuthority": { 408 | "$ref": "#/definitions/SslProductCertificateAuthority" 409 | }, 410 | "periods": { 411 | "type": "array", 412 | "items": { 413 | "type": "integer", 414 | "format": "int32" 415 | } 416 | }, 417 | "wildcard": { 418 | "type": "boolean" 419 | }, 420 | "authMethods": { 421 | "type": "array", 422 | "items": { 423 | "$ref": "#/definitions/SslProductAuthMethod" 424 | } 425 | }, 426 | "mandatoryContacts": { 427 | "type": "array", 428 | "items": { 429 | "type": "string" 430 | } 431 | }, 432 | "vulnerabilityAnalysis": { 433 | "type": "boolean" 434 | }, 435 | "malwareScan": { 436 | "type": "boolean" 437 | }, 438 | "sealInSearch": { 439 | "type": "boolean" 440 | }, 441 | "greenAddressBar": { 442 | "type": "boolean" 443 | }, 444 | "companyVisible": { 445 | "type": "boolean" 446 | }, 447 | "trustSeal": { 448 | "type": "boolean" 449 | }, 450 | "encryptionStrength": { 451 | "type": "string" 452 | }, 453 | "assurance": { 454 | "type": "string" 455 | }, 456 | "trustLevel": { 457 | "type": "integer", 458 | "format": "int32" 459 | }, 460 | "digitalIdUsage": { 461 | "$ref": "#/definitions/SslProductDigitalIdUsage" 462 | }, 463 | "digitalIdVerification": { 464 | "type": "array", 465 | "items": { 466 | "$ref": "#/definitions/SslProductDigitalIdVerification" 467 | } 468 | }, 469 | "digitalIdAuthentication": { 470 | "type": "array", 471 | "items": { 472 | "$ref": "#/definitions/SslProductDigitalIdAuthentication" 473 | } 474 | }, 475 | "san": { 476 | "$ref": "#/definitions/SanInformation" 477 | }, 478 | "csr": { 479 | "$ref": "#/definitions/CsrInformation" 480 | }, 481 | "dataControllers": { 482 | "type": "array", 483 | "items": { 484 | "$ref": "#/definitions/SslDataController" 485 | } 486 | }, 487 | "blacklistedTasks": { 488 | "type": "array", 489 | "items": { 490 | "type": "string" 491 | } 492 | }, 493 | "public": { 494 | "type": "boolean" 495 | }, 496 | "caaRecordValue": { 497 | "type": "string" 498 | }, 499 | "requiredFields": { 500 | "type": "array", 501 | "items": { 502 | "type": "string" 503 | } 504 | }, 505 | "serverSoftware": { 506 | "type": "array", 507 | "items": { 508 | "type": "string" 509 | } 510 | }, 511 | "codesigningTypes": { 512 | "type": "array", 513 | "items": { 514 | "type": "string" 515 | } 516 | }, 517 | "certificateTransparency": { 518 | "type": "array", 519 | "items": { 520 | "type": "string" 521 | } 522 | }, 523 | "signatureHashAlgorithms": { 524 | "type": "array", 525 | "items": { 526 | "type": "string" 527 | } 528 | } 529 | } 530 | }, 531 | "SslProductData": { 532 | "type": "object", 533 | "properties": { 534 | "data": { 535 | "type": "array", 536 | "items": { 537 | "$ref": "#/definitions/SslProduct" 538 | } 539 | } 540 | } 541 | }, 542 | "SslProductProvider": { 543 | "type": "string", 544 | "enum": [ 545 | "SYMANTEC", 546 | "SYMANTEC_STARTER", 547 | "GLOBALSIGN", 548 | "DIGICERT_DV", 549 | "COMODO", 550 | "MANUAL_CERTIFICATE", 551 | "MANUAL", 552 | "INTEGRATIONPROVIDER" 553 | ] 554 | }, 555 | "SslProductCertificateType": { 556 | "type": "string", 557 | "enum": [ 558 | "FQDN", 559 | "MAIL", 560 | "CODE" 561 | ] 562 | }, 563 | "SslProductValidationType": { 564 | "type": "string", 565 | "enum": [ 566 | "DV", 567 | "EV", 568 | "OV" 569 | ] 570 | }, 571 | "SslProductCertificateAuthority": { 572 | "type": "string", 573 | "enum": [ 574 | "Globalsign", 575 | "Symantec", 576 | "Comodo", 577 | "Thawte", 578 | "GeoTrust" 579 | ] 580 | }, 581 | "SslProductAuthMethod": { 582 | "type": "string", 583 | "enum": [ 584 | "EMAIL", 585 | "FILE", 586 | "DNS", 587 | "ORG" 588 | ] 589 | }, 590 | "SslProductDigitalIdUsage": { 591 | "type": "string", 592 | "enum": [ 593 | "GENERAL", 594 | "PERSONAL", 595 | "DEPARTMENT", 596 | "COMPANY" 597 | ] 598 | }, 599 | "SslProductDigitalIdVerification": { 600 | "type": "string", 601 | "enum": [ 602 | "EMAIL", 603 | "IDENTITY", 604 | "ORGANIZATION" 605 | ] 606 | }, 607 | "SslProductDigitalIdAuthentication": { 608 | "type": "string", 609 | "enum": [ 610 | "EMAIL", 611 | "IDENTITY_CARD", 612 | "CALL", 613 | "COMMERCIAL_REGISTER" 614 | ] 615 | }, 616 | "SslProductCsrHashAlgorithm": { 617 | "type": "string", 618 | "enum": [ 619 | "ECC", 620 | "RSA", 621 | "DSA" 622 | ] 623 | }, 624 | "CsrInformation": { 625 | "type": "object", 626 | "properties": { 627 | "keySizes": { 628 | "type": "array", 629 | "items": { 630 | "type": "string" 631 | } 632 | }, 633 | "hashAlgorithms": { 634 | "type": "array", 635 | "items": { 636 | "type": "string" 637 | } 638 | } 639 | } 640 | }, 641 | "SanInformation": { 642 | "type": "object", 643 | "properties": { 644 | "min": { 645 | "type": "integer", 646 | "format": "int32" 647 | }, 648 | "max": { 649 | "type": "integer", 650 | "format": "int32" 651 | }, 652 | "inclusive": { 653 | "type": "integer", 654 | "format": "int32" 655 | }, 656 | "included": { 657 | "type": "array", 658 | "items": { 659 | "type": "string" 660 | } 661 | } 662 | } 663 | }, 664 | "SslDataController": { 665 | "type": "object", 666 | "properties": { 667 | "name": { 668 | "type": "string" 669 | }, 670 | "address": { 671 | "type": "array", 672 | "items": { 673 | "type": "string" 674 | } 675 | } 676 | } 677 | }, 678 | "SslProductPagination": { 679 | "type": "object", 680 | "properties": { 681 | "current_page": { 682 | "type": "integer", 683 | "format": "int32" 684 | }, 685 | "from": { 686 | "type": "integer", 687 | "format": "int32" 688 | }, 689 | "last_page": { 690 | "type": "integer", 691 | "format": "int32" 692 | }, 693 | "per_page": { 694 | "type": "integer", 695 | "format": "int32" 696 | }, 697 | "to": { 698 | "type": "integer", 699 | "format": "int32" 700 | }, 701 | "total": { 702 | "type": "integer", 703 | "format": "int32" 704 | }, 705 | "data": { 706 | "type": "array", 707 | "items": { 708 | "$ref": "#/definitions/SslProduct" 709 | } 710 | } 711 | } 712 | }, 713 | "TldProductResponse": { 714 | "type": "object", 715 | "properties": { 716 | "data": { 717 | "$ref": "#/definitions/TldProduct" 718 | } 719 | } 720 | }, 721 | "TldProductsResponse": { 722 | "type": "object", 723 | "properties": { 724 | "data": { 725 | "type": "array", 726 | "items": { 727 | "$ref": "#/definitions/TldProduct" 728 | } 729 | } 730 | } 731 | }, 732 | "TldProduct": { 733 | "type": "object", 734 | "properties": { 735 | "id": { 736 | "type": "integer", 737 | "format": "int32" 738 | }, 739 | "label": { 740 | "type": "string" 741 | }, 742 | "charMin": { 743 | "type": "integer", 744 | "format": "int32" 745 | }, 746 | "charMax": { 747 | "type": "integer", 748 | "format": "int32" 749 | }, 750 | "dnssecMin": { 751 | "type": "integer", 752 | "format": "int32" 753 | }, 754 | "dnssecMax": { 755 | "type": "integer", 756 | "format": "int32" 757 | }, 758 | "dnssecAlgorithms": { 759 | "type": "array", 760 | "items": { 761 | "type": "integer", 762 | "format": "int32" 763 | } 764 | }, 765 | "nserverMin": { 766 | "type": "integer", 767 | "format": "int32" 768 | }, 769 | "nserverMax": { 770 | "type": "integer", 771 | "format": "int32" 772 | }, 773 | "ipv4Min": { 774 | "type": "integer", 775 | "format": "int32" 776 | }, 777 | "ipv4Max": { 778 | "type": "integer", 779 | "format": "int32" 780 | }, 781 | "ipv6Min": { 782 | "type": "integer", 783 | "format": "int32" 784 | }, 785 | "ipv6Max": { 786 | "type": "integer", 787 | "format": "int32" 788 | }, 789 | "nsentryMin": { 790 | "type": "integer", 791 | "format": "int32" 792 | }, 793 | "nsentryMax": { 794 | "type": "integer", 795 | "format": "int32" 796 | }, 797 | "rootNserver": { 798 | "type": "array", 799 | "items": { 800 | "type": "string" 801 | } 802 | }, 803 | "dnssecRecord": { 804 | "type": "integer", 805 | "format": "int32" 806 | }, 807 | "restoreArgpPeriod": { 808 | "$ref": "#/definitions/TimePeriod" 809 | }, 810 | "restoreRgpPeriod": { 811 | "$ref": "#/definitions/TimePeriod" 812 | }, 813 | "cancelationPeriod": { 814 | "$ref": "#/definitions/TimePeriod" 815 | }, 816 | "taskCreate": { 817 | "type": "boolean" 818 | }, 819 | "taskUpdate": { 820 | "type": "boolean" 821 | }, 822 | "taskDelete": { 823 | "type": "boolean" 824 | }, 825 | "taskRenew": { 826 | "type": "boolean" 827 | }, 828 | "taskTransfer": { 829 | "type": "boolean" 830 | }, 831 | "taskTransit": { 832 | "type": "boolean" 833 | }, 834 | "taskPreack": { 835 | "type": "boolean" 836 | }, 837 | "taskRestore": { 838 | "type": "boolean" 839 | }, 840 | "taskAuthinfoCreate": { 841 | "type": "boolean" 842 | }, 843 | "taskAuthinfoDelete": { 844 | "type": "boolean" 845 | }, 846 | "taskAuthinfo2": { 847 | "type": "boolean" 848 | }, 849 | "taskStatusUpdate": { 850 | "type": "boolean" 851 | }, 852 | "taskOwnerChange": { 853 | "type": "boolean" 854 | }, 855 | "cancelationExpireOnly": { 856 | "type": "boolean" 857 | }, 858 | "registrarStatus": { 859 | "type": "array", 860 | "items": { 861 | "type": "string" 862 | } 863 | }, 864 | "authinfo1Location": { 865 | "type": "array", 866 | "items": { 867 | "$ref": "#/definitions/AuthInfo1Location" 868 | } 869 | }, 870 | "numeralDomains": { 871 | "type": "boolean" 872 | }, 873 | "realtime": { 874 | "type": "boolean" 875 | }, 876 | "idn": { 877 | "type": "array", 878 | "items": { 879 | "$ref": "#/definitions/Charset" 880 | } 881 | }, 882 | "transferComfirmation": { 883 | "type": "boolean" 884 | }, 885 | "dnsCheck": { 886 | "type": "boolean" 887 | }, 888 | "premiumDomains": { 889 | "type": "boolean" 890 | }, 891 | "contactExtensions": { 892 | "type": "array", 893 | "items": { 894 | "type": "string" 895 | } 896 | }, 897 | "privacy": { 898 | "type": "boolean" 899 | }, 900 | "trustee": { 901 | "type": "boolean" 902 | }, 903 | "thirdLevel": { 904 | "type": "boolean" 905 | }, 906 | "transferAuthinfo": { 907 | "type": "boolean" 908 | }, 909 | "ownerchangeAuthinfo": { 910 | "type": "boolean" 911 | }, 912 | "errorCodes": { 913 | "type": "array", 914 | "items": { 915 | "type": "string" 916 | } 917 | }, 918 | "tldType": { 919 | "$ref": "#/definitions/TldType" 920 | }, 921 | "tldContinent": { 922 | "$ref": "#/definitions/TldContinent" 923 | }, 924 | "category": { 925 | "$ref": "#/definitions/Category" 926 | }, 927 | "confluencePageDe": { 928 | "type": "string" 929 | }, 930 | "confluencePageEn": { 931 | "type": "string" 932 | }, 933 | "commentDe": { 934 | "type": "string" 935 | }, 936 | "commentEn": { 937 | "type": "string" 938 | }, 939 | "whois": { 940 | "type": "string" 941 | }, 942 | "countryIso": { 943 | "type": "string" 944 | }, 945 | "geoPol": { 946 | "type": "string" 947 | }, 948 | "officialLanguage": { 949 | "type": "string" 950 | }, 951 | "restrictions": { 952 | "type": "array", 953 | "items": { 954 | "$ref": "#/definitions/Condition" 955 | } 956 | }, 957 | "country": { 958 | "$ref": "#/definitions/Country" 959 | }, 960 | "dataControllers": { 961 | "type": "array", 962 | "items": { 963 | "$ref": "#/definitions/TldDataController" 964 | } 965 | }, 966 | "preregInformation": { 967 | "type": "array", 968 | "items": { 969 | "$ref": "#/definitions/PreregInformation" 970 | } 971 | }, 972 | "rankingLevel": { 973 | "type": "integer", 974 | "format": "int32" 975 | }, 976 | "tldTasks": { 977 | "type": "array", 978 | "items": { 979 | "$ref": "#/definitions/TldTask" 980 | } 981 | }, 982 | "tldDns": { 983 | "$ref": "#/definitions/TldDns" 984 | }, 985 | "tldPeriod": { 986 | "$ref": "#/definitions/TldPeriod" 987 | }, 988 | "isManual": { 989 | "type": "boolean" 990 | }, 991 | "requiredFields": { 992 | "type": "array", 993 | "items": { 994 | "type": "string" 995 | } 996 | } 997 | } 998 | }, 999 | "AuthInfo1Location": { 1000 | "type": "string", 1001 | "enum": [ 1002 | "REGISTRAR", 1003 | "REGISTRY", 1004 | "REGISTRANT" 1005 | ] 1006 | }, 1007 | "TldType": { 1008 | "type": "string", 1009 | "enum": [ 1010 | "CCTLD", 1011 | "GTLD", 1012 | "NEW_GTLD" 1013 | ] 1014 | }, 1015 | "TldContinent": { 1016 | "type": "string", 1017 | "enum": [ 1018 | "ASIA", 1019 | "AFRICA", 1020 | "NORTH_AMERICA", 1021 | "SOUTH_AMERICA", 1022 | "ANTARCTICA", 1023 | "EUROPE", 1024 | "OCEANIA", 1025 | "GLOBAL" 1026 | ] 1027 | }, 1028 | "Category": { 1029 | "type": "string", 1030 | "enum": [ 1031 | "BUSINESS", 1032 | "COMMUNITY", 1033 | "ECOMMERCE", 1034 | "FOOD", 1035 | "GEO_TRAVEL", 1036 | "SPORT_FUN", 1037 | "WEB_TECH" 1038 | ] 1039 | }, 1040 | "Charset": { 1041 | "type": "string", 1042 | "enum": [ 1043 | "BIG5", 1044 | "EUC_JP", 1045 | "EUC_KR", 1046 | "ISCII", 1047 | "KOI8_R", 1048 | "KOI8_U", 1049 | "SHIFT_JIS", 1050 | "TIS_620" 1051 | ] 1052 | }, 1053 | "Condition": { 1054 | "type": "object", 1055 | "properties": { 1056 | "text": { 1057 | "type": "string" 1058 | }, 1059 | "language": { 1060 | "type": "string" 1061 | } 1062 | } 1063 | }, 1064 | "TldDataController": { 1065 | "type": "object", 1066 | "properties": { 1067 | "type": { 1068 | "type": "string" 1069 | }, 1070 | "name": { 1071 | "type": "string" 1072 | }, 1073 | "organisation": { 1074 | "type": "string" 1075 | }, 1076 | "address": { 1077 | "type": "array", 1078 | "items": { 1079 | "type": "string" 1080 | } 1081 | } 1082 | } 1083 | }, 1084 | "TldProductPagination": { 1085 | "type": "object", 1086 | "properties": { 1087 | "current_page": { 1088 | "type": "integer", 1089 | "format": "int32" 1090 | }, 1091 | "from": { 1092 | "type": "integer", 1093 | "format": "int32" 1094 | }, 1095 | "last_page": { 1096 | "type": "integer", 1097 | "format": "int32" 1098 | }, 1099 | "per_page": { 1100 | "type": "integer", 1101 | "format": "int32" 1102 | }, 1103 | "to": { 1104 | "type": "integer", 1105 | "format": "int32" 1106 | }, 1107 | "total": { 1108 | "type": "integer", 1109 | "format": "int32" 1110 | }, 1111 | "data": { 1112 | "type": "array", 1113 | "items": { 1114 | "$ref": "#/definitions/TldProduct" 1115 | } 1116 | } 1117 | } 1118 | }, 1119 | "PreregInformation": { 1120 | "type": "object", 1121 | "properties": { 1122 | "phase": { 1123 | "type": "string" 1124 | }, 1125 | "confirmationStart": { 1126 | "type": "string", 1127 | "format": "date" 1128 | }, 1129 | "confirmationEnd": { 1130 | "type": "string", 1131 | "format": "date" 1132 | }, 1133 | "periodStart": { 1134 | "type": "string", 1135 | "format": "date" 1136 | }, 1137 | "periodEnd": { 1138 | "type": "string", 1139 | "format": "date" 1140 | }, 1141 | "category": { 1142 | "type": "string" 1143 | }, 1144 | "registrationType": { 1145 | "type": "string" 1146 | }, 1147 | "minPeriod": { 1148 | "$ref": "#/definitions/TimePeriod" 1149 | } 1150 | } 1151 | }, 1152 | "TldTask": { 1153 | "type": "object", 1154 | "properties": { 1155 | "label": { 1156 | "type": "string" 1157 | }, 1158 | "available": { 1159 | "type": "boolean" 1160 | }, 1161 | "chargeable": { 1162 | "type": "boolean" 1163 | } 1164 | } 1165 | }, 1166 | "TldDns": { 1167 | "type": "object", 1168 | "properties": { 1169 | "dnssecMin": { 1170 | "type": "integer", 1171 | "format": "int32" 1172 | }, 1173 | "dnssecMax": { 1174 | "type": "integer", 1175 | "format": "int32" 1176 | }, 1177 | "dnssecAlgorithms": { 1178 | "type": "array", 1179 | "items": { 1180 | "type": "integer", 1181 | "format": "int32" 1182 | } 1183 | }, 1184 | "nserverMin": { 1185 | "type": "integer", 1186 | "format": "int32" 1187 | }, 1188 | "nserverMax": { 1189 | "type": "integer", 1190 | "format": "int32" 1191 | }, 1192 | "ipv4Min": { 1193 | "type": "integer", 1194 | "format": "int32" 1195 | }, 1196 | "ipv4Max": { 1197 | "type": "integer", 1198 | "format": "int32" 1199 | }, 1200 | "ipv6Min": { 1201 | "type": "integer", 1202 | "format": "int32" 1203 | }, 1204 | "ipv6Max": { 1205 | "type": "integer", 1206 | "format": "int32" 1207 | }, 1208 | "nsentryMin": { 1209 | "type": "integer", 1210 | "format": "int32" 1211 | }, 1212 | "nsentryMax": { 1213 | "type": "integer", 1214 | "format": "int32" 1215 | } 1216 | } 1217 | }, 1218 | "TldPeriod": { 1219 | "type": "object", 1220 | "properties": { 1221 | "restoreArgpPeriod": { 1222 | "$ref": "#/definitions/TimePeriod" 1223 | }, 1224 | "restoreRgpPeriod": { 1225 | "$ref": "#/definitions/TimePeriod" 1226 | }, 1227 | "cancelationPeriod": { 1228 | "$ref": "#/definitions/TimePeriod" 1229 | } 1230 | } 1231 | }, 1232 | "Country": { 1233 | "type": "object", 1234 | "properties": { 1235 | "isoCode": { 1236 | "type": "string" 1237 | }, 1238 | "countrynameDe": { 1239 | "type": "string" 1240 | }, 1241 | "countrynameEn": { 1242 | "type": "string" 1243 | } 1244 | } 1245 | }, 1246 | "TimePeriod": { 1247 | "type": "object", 1248 | "properties": { 1249 | "unit": { 1250 | "$ref": "#/definitions/TimeUnitConstants" 1251 | }, 1252 | "period": { 1253 | "type": "integer", 1254 | "format": "int64" 1255 | } 1256 | } 1257 | }, 1258 | "TimeUnitConstants": { 1259 | "type": "string", 1260 | "enum": [ 1261 | "ms", 1262 | "s", 1263 | "min", 1264 | "h", 1265 | "d", 1266 | "w", 1267 | "m", 1268 | "q", 1269 | "y", 1270 | "year", 1271 | "day", 1272 | "hour" 1273 | ] 1274 | }, 1275 | "ErrorResponse": { 1276 | "type": "object", 1277 | "properties": { 1278 | "code": { 1279 | "type": "integer", 1280 | "format": "int32" 1281 | }, 1282 | "message": { 1283 | "type": "string" 1284 | } 1285 | } 1286 | } 1287 | } 1288 | } 1289 | -------------------------------------------------------------------------------- /src/pcdomains.json: -------------------------------------------------------------------------------- 1 | { 2 | "swagger": "2.0", 3 | "info": { 4 | "description": "The documentation for the internal price estimation API.
Every request expects the following headers:
  • Content-Type: application/json
  • Accept: application/json
", 5 | "version": "1.2.0", 6 | "title": "Service Pricer API" 7 | }, 8 | "host": "api.autodns.com", 9 | "basePath": "/v1/service/pricer", 10 | "tags": [ 11 | { 12 | "name": "estimation", 13 | "description": "Estimate the value for domains" 14 | } 15 | ], 16 | "schemes": [ 17 | "https" 18 | ], 19 | "paths": { 20 | "/alexasiteinfo/{domain}": { 21 | "get": { 22 | "tags": [ 23 | "alexa site info" 24 | ], 25 | "summary": "Get AlexaSiteInfo(Amazon) data", 26 | "description": "Get AlexaSiteInfo(Amazon) data", 27 | "produces": [ 28 | "application/json" 29 | ], 30 | "parameters": [ 31 | { 32 | "name": "domain", 33 | "in": "path", 34 | "description": "Domain to get the data for", 35 | "required": true, 36 | "type": "string" 37 | } 38 | ], 39 | "responses": { 40 | "200": { 41 | "description": "successful operation", 42 | "schema": { 43 | "$ref": "#/definitions/ApiAlexaSiteInfoResponse" 44 | } 45 | } 46 | } 47 | } 48 | }, 49 | "/v1/estimate": { 50 | "post": { 51 | "tags": [ 52 | "estimation" 53 | ], 54 | "summary": "Estimate the value for the given domain", 55 | "description": "Estimate the value for the given domain; A maximum of 20 domains can be estimated per request.", 56 | "produces": [ 57 | "application/json" 58 | ], 59 | "consumes": [ 60 | "application/json" 61 | ], 62 | "parameters": [ 63 | { 64 | "in": "body", 65 | "name": "", 66 | "schema": { 67 | "$ref": "#/definitions/Estimation" 68 | } 69 | } 70 | ], 71 | "responses": { 72 | "200": { 73 | "description": "successful operation", 74 | "schema": { 75 | "$ref": "#/definitions/ApiV1EstimationResponse" 76 | } 77 | }, 78 | "400": { 79 | "description": "Bad Request", 80 | "schema": { 81 | "$ref": "#/definitions/ApiEstimationErrorResponse" 82 | } 83 | }, 84 | "401": { 85 | "description": "Unauthorized; Invalid or missing JWT", 86 | "schema": { 87 | "$ref": "#/definitions/ApiEstimationErrorResponse" 88 | } 89 | }, 90 | "422": { 91 | "description": "Invalid request", 92 | "schema": { 93 | "$ref": "#/definitions/ApiEstimationErrorResponse" 94 | } 95 | }, 96 | "429": { 97 | "description": "Too many requests; Quota limit reached", 98 | "schema": { 99 | "$ref": "#/definitions/ApiEstimationErrorResponse" 100 | } 101 | } 102 | } 103 | } 104 | }, 105 | "/v1/exchangerate/{source}/{target}": { 106 | "get": { 107 | "tags": [ 108 | "currency, exchangerate" 109 | ], 110 | "summary": "Get an exchangerate for a currency", 111 | "description": "Get an exchangerate for for source-currency to target-currency", 112 | "produces": [ 113 | "application/json" 114 | ], 115 | "parameters": [ 116 | { 117 | "name": "source", 118 | "in": "path", 119 | "description": "Source Currency", 120 | "required": true, 121 | "type": "string" 122 | }, 123 | { 124 | "name": "target", 125 | "in": "path", 126 | "description": "Target Currency", 127 | "required": true, 128 | "type": "string" 129 | } 130 | ], 131 | "responses": { 132 | "200": { 133 | "description": "successful operation", 134 | "schema": { 135 | "$ref": "#/definitions/ApiExchangeRateResponse" 136 | } 137 | }, 138 | "400": { 139 | "description": "Bad Request", 140 | "schema": { 141 | "$ref": "#/definitions/ApiEstimationErrorResponse" 142 | } 143 | }, 144 | "401": { 145 | "description": "Unauthorized; Invalid or missing JWT", 146 | "schema": { 147 | "$ref": "#/definitions/ApiEstimationErrorResponse" 148 | } 149 | }, 150 | "422": { 151 | "description": "Invalid request", 152 | "schema": { 153 | "$ref": "#/definitions/ApiEstimationErrorResponse" 154 | } 155 | }, 156 | "429": { 157 | "description": "Too many requests; Quota limit reached", 158 | "schema": { 159 | "$ref": "#/definitions/ApiEstimationErrorResponse" 160 | } 161 | } 162 | } 163 | } 164 | }, 165 | "/domainstudio/suggest/{keyword}": { 166 | "get": { 167 | "tags": [ 168 | "DomainStudio" 169 | ], 170 | "summary": "Get a list of domain name suggestions", 171 | "description": "Get a list of domain name suggestions", 172 | "produces": [ 173 | "application/json" 174 | ], 175 | "parameters": [ 176 | { 177 | "name": "keyword", 178 | "in": "path", 179 | "description": "Keyword to get the suggestions for", 180 | "required": true, 181 | "type": "string" 182 | } 183 | ], 184 | "responses": { 185 | "200": { 186 | "description": "successful operation", 187 | "schema": { 188 | "$ref": "#/definitions/ApiDomainStudioResponse" 189 | } 190 | }, 191 | "400": { 192 | "description": "Bad Request", 193 | "schema": { 194 | "$ref": "#/definitions/ApiEstimationErrorResponse" 195 | } 196 | }, 197 | "401": { 198 | "description": "Unauthorized; Invalid or missing JWT", 199 | "schema": { 200 | "$ref": "#/definitions/ApiEstimationErrorResponse" 201 | } 202 | }, 203 | "422": { 204 | "description": "Invalid request", 205 | "schema": { 206 | "$ref": "#/definitions/ApiEstimationErrorResponse" 207 | } 208 | }, 209 | "429": { 210 | "description": "Too many requests; Quota limit reached", 211 | "schema": { 212 | "$ref": "#/definitions/ApiEstimationErrorResponse" 213 | } 214 | } 215 | } 216 | } 217 | }, 218 | "/kwe": { 219 | "post": { 220 | "tags": [ 221 | "keyword" 222 | ], 223 | "summary": "Get Google Ad Words data for given keywords", 224 | "description": "Get Google Ad Words data for given keywords", 225 | "produces": [ 226 | "application/json" 227 | ], 228 | "consumes": [ 229 | "application/json" 230 | ], 231 | "parameters": [ 232 | { 233 | "in": "body", 234 | "name": "", 235 | "schema": { 236 | "$ref": "#/definitions/Keywords" 237 | } 238 | } 239 | ], 240 | "responses": { 241 | "200": { 242 | "description": "successful operation", 243 | "schema": { 244 | "$ref": "#/definitions/ApiKeywordResponse" 245 | } 246 | }, 247 | "400": { 248 | "description": "Bad Request", 249 | "schema": { 250 | "$ref": "#/definitions/ApiEstimationErrorResponse" 251 | } 252 | }, 253 | "401": { 254 | "description": "Unauthorized; Invalid or missing JWT", 255 | "schema": { 256 | "$ref": "#/definitions/ApiEstimationErrorResponse" 257 | } 258 | }, 259 | "422": { 260 | "description": "Invalid request", 261 | "schema": { 262 | "$ref": "#/definitions/ApiEstimationErrorResponse" 263 | } 264 | }, 265 | "429": { 266 | "description": "Too many requests; Quota limit reached", 267 | "schema": { 268 | "$ref": "#/definitions/ApiEstimationErrorResponse" 269 | } 270 | } 271 | } 272 | } 273 | }, 274 | "/meta/{domain}": { 275 | "get": { 276 | "tags": [ 277 | "meta" 278 | ], 279 | "summary": "Get meta information like online status, site title/description etc.", 280 | "description": "Get meta information like online status, site title/des", 281 | "produces": [ 282 | "application/json" 283 | ], 284 | "parameters": [ 285 | { 286 | "name": "domain", 287 | "in": "path", 288 | "description": "Domain to get the data for", 289 | "required": true, 290 | "type": "string" 291 | } 292 | ], 293 | "responses": { 294 | "200": { 295 | "description": "successful operation", 296 | "schema": { 297 | "$ref": "#/definitions/ApiMetaResponse" 298 | } 299 | }, 300 | "400": { 301 | "description": "Bad Request", 302 | "schema": { 303 | "$ref": "#/definitions/ApiEstimationErrorResponse" 304 | } 305 | }, 306 | "401": { 307 | "description": "Unauthorized; Invalid or missing JWT", 308 | "schema": { 309 | "$ref": "#/definitions/ApiEstimationErrorResponse" 310 | } 311 | }, 312 | "422": { 313 | "description": "Invalid request", 314 | "schema": { 315 | "$ref": "#/definitions/ApiEstimationErrorResponse" 316 | } 317 | }, 318 | "429": { 319 | "description": "Too many requests; Quota limit reached", 320 | "schema": { 321 | "$ref": "#/definitions/ApiEstimationErrorResponse" 322 | } 323 | } 324 | } 325 | } 326 | }, 327 | "/sistrix/{domain}[/{country}]": { 328 | "get": { 329 | "tags": [ 330 | "Sistrix" 331 | ], 332 | "summary": "Get Sistrix data", 333 | "description": "Get Sistrix data", 334 | "produces": [ 335 | "application/json" 336 | ], 337 | "parameters": [ 338 | { 339 | "name": "domain", 340 | "in": "path", 341 | "description": "Domain to get the data for", 342 | "required": true, 343 | "type": "string" 344 | }, 345 | { 346 | "name": "country", 347 | "in": "path", 348 | "description": "Country (ISO Code) to get the data for", 349 | "required": true, 350 | "type": "string" 351 | } 352 | ], 353 | "responses": { 354 | "200": { 355 | "description": "successful operation", 356 | "schema": { 357 | "$ref": "#/definitions/ApiSistrixResponse" 358 | } 359 | }, 360 | "400": { 361 | "description": "Bad Request", 362 | "schema": { 363 | "$ref": "#/definitions/ApiEstimationErrorResponse" 364 | } 365 | }, 366 | "401": { 367 | "description": "Unauthorized; Invalid or missing JWT", 368 | "schema": { 369 | "$ref": "#/definitions/ApiEstimationErrorResponse" 370 | } 371 | }, 372 | "422": { 373 | "description": "Invalid request", 374 | "schema": { 375 | "$ref": "#/definitions/ApiEstimationErrorResponse" 376 | } 377 | }, 378 | "429": { 379 | "description": "Too many requests; Quota limit reached", 380 | "schema": { 381 | "$ref": "#/definitions/ApiEstimationErrorResponse" 382 | } 383 | } 384 | } 385 | } 386 | }, 387 | "/majestic": { 388 | "post": { 389 | "tags": [ 390 | "Majestic" 391 | ], 392 | "summary": "Get Majestic data", 393 | "description": "Get Majestic data", 394 | "produces": [ 395 | "application/json" 396 | ], 397 | "consumes": [ 398 | "application/json" 399 | ], 400 | "parameters": [ 401 | { 402 | "name": "domain", 403 | "in": "body", 404 | "description": "Domains to get the data for", 405 | "required": true, 406 | "schema": { 407 | "$ref": "#/definitions/Domains" 408 | } 409 | } 410 | ], 411 | "responses": { 412 | "200": { 413 | "description": "successful operation", 414 | "schema": { 415 | "$ref": "#/definitions/ApiMajesticResponse" 416 | } 417 | }, 418 | "400": { 419 | "description": "Bad Request", 420 | "schema": { 421 | "$ref": "#/definitions/ApiEstimationErrorResponse" 422 | } 423 | }, 424 | "401": { 425 | "description": "Unauthorized; Invalid or missing JWT", 426 | "schema": { 427 | "$ref": "#/definitions/ApiEstimationErrorResponse" 428 | } 429 | }, 430 | "422": { 431 | "description": "Invalid request", 432 | "schema": { 433 | "$ref": "#/definitions/ApiEstimationErrorResponse" 434 | } 435 | }, 436 | "429": { 437 | "description": "Too many requests; Quota limit reached", 438 | "schema": { 439 | "$ref": "#/definitions/ApiEstimationErrorResponse" 440 | } 441 | } 442 | } 443 | } 444 | }, 445 | "/smu_check": { 446 | "post": { 447 | "tags": [ 448 | "social media" 449 | ], 450 | "summary": "Check if usernames are available on different social media plattforms", 451 | "description": "Check if usernames are available on different social media plattform", 452 | "produces": [ 453 | "application/json" 454 | ], 455 | "parameters": [ 456 | { 457 | "name": "searchToken", 458 | "in": "body", 459 | "description": "The token to search after", 460 | "required": true, 461 | "schema" : { 462 | "$ref" : "#/definitions/SocialMedia" 463 | } 464 | }, 465 | { 466 | "name": "platforms", 467 | "in": "body", 468 | "description": "The platforms to check", 469 | "required": true, 470 | "schema": { 471 | "$ref" : "#/definitions/Platform" 472 | } 473 | } 474 | ], 475 | "responses": { 476 | "200": { 477 | "description": "successful operation", 478 | "schema": { 479 | "$ref": "#/definitions/ApiSocialMediaResponse" 480 | } 481 | }, 482 | "400": { 483 | "description": "Bad Request", 484 | "schema": { 485 | "$ref": "#/definitions/ApiEstimationErrorResponse" 486 | } 487 | }, 488 | "401": { 489 | "description": "Unauthorized; Invalid or missing JWT", 490 | "schema": { 491 | "$ref": "#/definitions/ApiEstimationErrorResponse" 492 | } 493 | }, 494 | "422": { 495 | "description": "Invalid request", 496 | "schema": { 497 | "$ref": "#/definitions/ApiEstimationErrorResponse" 498 | } 499 | }, 500 | "429": { 501 | "description": "Too many requests; Quota limit reached", 502 | "schema": { 503 | "$ref": "#/definitions/ApiEstimationErrorResponse" 504 | } 505 | } 506 | } 507 | } 508 | }, 509 | "/wayback/{domain}": { 510 | "get": { 511 | "tags": [ 512 | "wayback" 513 | ], 514 | "summary": "Retrieve info from Wayback snapshot archive", 515 | "description": "Retrieve info from Wayback snapshot archive", 516 | "produces": [ 517 | "application/json" 518 | ], 519 | "parameters": [ 520 | { 521 | "name": "domain", 522 | "in": "path", 523 | "description": "Domain to get the data for", 524 | "required": true, 525 | "type": "string" 526 | } 527 | ], 528 | "responses": { 529 | "200": { 530 | "description": "successful operation", 531 | "schema": { 532 | "$ref": "#/definitions/ApiWaybackResponse" 533 | } 534 | }, 535 | "400": { 536 | "description": "Bad Request", 537 | "schema": { 538 | "$ref": "#/definitions/ApiEstimationErrorResponse" 539 | } 540 | }, 541 | "401": { 542 | "description": "Unauthorized; Invalid or missing JWT", 543 | "schema": { 544 | "$ref": "#/definitions/ApiEstimationErrorResponse" 545 | } 546 | }, 547 | "422": { 548 | "description": "Invalid request", 549 | "schema": { 550 | "$ref": "#/definitions/ApiEstimationErrorResponse" 551 | } 552 | }, 553 | "429": { 554 | "description": "Too many requests; Quota limit reached", 555 | "schema": { 556 | "$ref": "#/definitions/ApiEstimationErrorResponse" 557 | } 558 | } 559 | } 560 | } 561 | } 562 | }, 563 | "securityDefinitions": { 564 | "Bearer": { 565 | "type": "apiKey", 566 | "name": "Authorization", 567 | "in": "header" 568 | } 569 | }, 570 | "definitions": { 571 | "ApiAlexaSiteInfoResponse": { 572 | "type": "object", 573 | "properties": { 574 | "messages": { 575 | "type": "array", 576 | "items": { 577 | "$ref": "#/definitions/ApiResponseMessages" 578 | } 579 | }, 580 | "object": { 581 | "$ref": "#/definitions/ApiResponseObject" 582 | }, 583 | "data": { 584 | "type": "array", 585 | "items": { 586 | "$ref": "#/definitions/AlexaSiteInfo" 587 | } 588 | } 589 | } 590 | }, 591 | "ApiDomainStudioResponse": { 592 | "type": "object", 593 | "properties": { 594 | "messages": { 595 | "type": "array", 596 | "items": { 597 | "$ref": "#/definitions/ApiResponseMessages" 598 | } 599 | }, 600 | "object": { 601 | "$ref": "#/definitions/ApiResponseObject" 602 | }, 603 | "data": { 604 | "type": "array", 605 | "items": { 606 | "$ref": "#/definitions/DomainStudio" 607 | } 608 | } 609 | } 610 | }, 611 | "ApiV1EstimationResponse": { 612 | "type": "object", 613 | "properties": { 614 | "messages": { 615 | "type": "array", 616 | "items": { 617 | "$ref": "#/definitions/ApiResponseMessages" 618 | } 619 | }, 620 | "object": { 621 | "$ref": "#/definitions/ApiResponseObject" 622 | }, 623 | "data": { 624 | "type": "array", 625 | "items": { 626 | "$ref": "#/definitions/EstimationV1" 627 | } 628 | } 629 | } 630 | }, 631 | "ApiEstimationResponse": { 632 | "type": "object", 633 | "properties": { 634 | "messages": { 635 | "type": "array", 636 | "items": { 637 | "$ref": "#/definitions/ApiResponseMessages" 638 | } 639 | }, 640 | "object": { 641 | "$ref": "#/definitions/ApiResponseObject" 642 | }, 643 | "data": { 644 | "type": "array", 645 | "items": { 646 | "$ref": "#/definitions/Estimation" 647 | } 648 | } 649 | } 650 | }, 651 | "ApiEstimationErrorResponse": { 652 | "type": "object", 653 | "properties": { 654 | "messages": { 655 | "type": "array", 656 | "items": { 657 | "$ref": "#/definitions/ApiResponseMessages" 658 | } 659 | }, 660 | "status": { 661 | "$ref": "#/definitions/ApiResponseMessages" 662 | }, 663 | "object": { 664 | "$ref": "#/definitions/ApiResponseObject", 665 | "items": { 666 | "$ref": "#/definitions/Keyword" 667 | } 668 | } 669 | } 670 | }, 671 | "ApiExchangeRateResponse": { 672 | "type": "object", 673 | "properties": { 674 | "messages": { 675 | "type": "array", 676 | "items": { 677 | "$ref": "#/definitions/ApiResponseMessages" 678 | } 679 | }, 680 | "object": { 681 | "$ref": "#/definitions/ApiResponseObject" 682 | }, 683 | "data": { 684 | "type": "array", 685 | "items": { 686 | "$ref": "#/definitions/ExchangeRate" 687 | } 688 | } 689 | } 690 | }, 691 | "ApiHistoryUserResponse": { 692 | "type": "object", 693 | "properties": { 694 | "messages": { 695 | "type": "array", 696 | "items": { 697 | "$ref": "#/definitions/ApiResponseMessages" 698 | } 699 | }, 700 | "object": { 701 | "$ref": "#/definitions/ApiResponseObject" 702 | }, 703 | "data": { 704 | "type": "array", 705 | "items": { 706 | "$ref": "#/definitions/HistoryUser" 707 | } 708 | } 709 | } 710 | }, 711 | "ApiKeywordResponse": { 712 | "type": "object", 713 | "properties": { 714 | "messages": { 715 | "type": "array", 716 | "items": { 717 | "$ref": "#/definitions/ApiResponseMessages" 718 | } 719 | }, 720 | "object": { 721 | "$ref": "#/definitions/ApiResponseObject" 722 | }, 723 | "data": { 724 | "type": "array", 725 | "items": { 726 | "$ref": "#/definitions/Keyword" 727 | } 728 | } 729 | } 730 | }, 731 | "ApiSistrixResponse": { 732 | "type": "object", 733 | "properties": { 734 | "messages": { 735 | "type": "array", 736 | "items": { 737 | "$ref": "#/definitions/ApiResponseMessages" 738 | } 739 | }, 740 | "object": { 741 | "$ref": "#/definitions/ApiResponseObject" 742 | }, 743 | "data": { 744 | "type": "array", 745 | "items": { 746 | "$ref": "#/definitions/Sistrix" 747 | } 748 | } 749 | } 750 | }, 751 | "ApiSocialMediaResponse": { 752 | "type": "object", 753 | "properties": { 754 | "messages": { 755 | "type": "array", 756 | "items": { 757 | "$ref": "#/definitions/ApiResponseMessages" 758 | } 759 | }, 760 | "object": { 761 | "$ref": "#/definitions/ApiResponseObject" 762 | }, 763 | "data": { 764 | "type": "array", 765 | "items": { 766 | "$ref": "#/definitions/SocialMedia" 767 | } 768 | } 769 | } 770 | }, 771 | "ApiStatisticsResponse": { 772 | "type": "object", 773 | "properties": { 774 | "messages": { 775 | "type": "array", 776 | "items": { 777 | "$ref": "#/definitions/ApiResponseMessages" 778 | } 779 | }, 780 | "object": { 781 | "$ref": "#/definitions/ApiResponseObject" 782 | }, 783 | "data": { 784 | "type": "array", 785 | "items": { 786 | "$ref": "#/definitions/EstimationStatistics" 787 | } 788 | } 789 | } 790 | }, 791 | "ApiUserStatisticsResponse": { 792 | "type": "object", 793 | "properties": { 794 | "messages": { 795 | "type": "array", 796 | "items": { 797 | "$ref": "#/definitions/ApiResponseMessages" 798 | } 799 | }, 800 | "object": { 801 | "$ref": "#/definitions/ApiResponseObject" 802 | }, 803 | "data": { 804 | "type": "array", 805 | "items": { 806 | "$ref": "#/definitions/UserEstimationStatistics" 807 | } 808 | } 809 | } 810 | }, 811 | "ApiMajesticResponse": { 812 | "type": "object", 813 | "properties": { 814 | "messages": { 815 | "type": "array", 816 | "items": { 817 | "$ref": "#/definitions/ApiResponseMessages" 818 | } 819 | }, 820 | "object": { 821 | "$ref": "#/definitions/ApiResponseObject" 822 | }, 823 | "data": { 824 | "type": "array", 825 | "items": { 826 | "$ref": "#/definitions/Majestic" 827 | } 828 | } 829 | } 830 | }, 831 | "ApiMetaResponse": { 832 | "type": "object", 833 | "properties": { 834 | "messages": { 835 | "type": "array", 836 | "items": { 837 | "$ref": "#/definitions/ApiResponseMessages" 838 | } 839 | }, 840 | "object": { 841 | "$ref": "#/definitions/ApiResponseObject" 842 | }, 843 | "data": { 844 | "type": "array", 845 | "items": { 846 | "$ref": "#/definitions/Meta" 847 | } 848 | } 849 | } 850 | }, 851 | "ApiWaybackResponse": { 852 | "type": "object", 853 | "properties": { 854 | "messages": { 855 | "type": "array", 856 | "items": { 857 | "$ref": "#/definitions/ApiResponseMessages" 858 | } 859 | }, 860 | "object": { 861 | "$ref": "#/definitions/ApiResponseObject" 862 | }, 863 | "data": { 864 | "type": "array", 865 | "items": { 866 | "$ref": "#/definitions/Wayback" 867 | } 868 | } 869 | } 870 | }, 871 | "ApiResponseMessages": { 872 | "type": "object", 873 | "properties": { 874 | "code": { 875 | "type": "string" 876 | }, 877 | "text": { 878 | "type": "string" 879 | }, 880 | "type": { 881 | "type": "string" 882 | } 883 | } 884 | }, 885 | "ApiResponseObject": { 886 | "type": "object", 887 | "properties": { 888 | "type": { 889 | "type": "string" 890 | }, 891 | "value": { 892 | "type": "string" 893 | } 894 | } 895 | }, 896 | "AlexaSiteInfo": { 897 | "type": "object", 898 | "properties": { 899 | "sitesLinkingIn": { 900 | "type": "integer" 901 | }, 902 | "rank": { 903 | "type": "integer" 904 | }, 905 | "loadingTime": { 906 | "type": "string" 907 | }, 908 | "adultContent": { 909 | "type": "string" 910 | }, 911 | "siteLanguage": { 912 | "type": "string" 913 | }, 914 | "siteData": { 915 | "type": "object", 916 | "properties": { 917 | "title": { 918 | "type": "string" 919 | }, 920 | "description": { 921 | "type": "string" 922 | }, 923 | "onlineSince": { 924 | "type": "string" 925 | } 926 | } 927 | }, 928 | "highestRankedIncountry": { 929 | "type": "object", 930 | "properties": { 931 | "contribution": { 932 | "type": "string" 933 | }, 934 | "rank": { 935 | "type": "integer" 936 | }, 937 | "county": { 938 | "type": "string" 939 | } 940 | } 941 | }, 942 | "pageViewsPerDay": { 943 | "type": "object", 944 | "properties": { 945 | "perUser": { 946 | "type": "integer" 947 | }, 948 | "codeltaunty": { 949 | "type": "string" 950 | } 951 | } 952 | } 953 | } 954 | }, 955 | "Domains": { 956 | "type": "object", 957 | "properties": { 958 | "domains": { 959 | "type": "array", 960 | "items": { 961 | "type": "string" 962 | } 963 | } 964 | } 965 | }, 966 | "DomainStudio": { 967 | "type": "array", 968 | "items": { 969 | "$ref": "#/definitions/DomainStudioItem" 970 | } 971 | }, 972 | "DomainStudioItem": { 973 | "type": "object", 974 | "properties": { 975 | "name": { 976 | "type": "string" 977 | }, 978 | "availability": { 979 | "type": "string" 980 | }, 981 | "status": { 982 | "type": "string" 983 | }, 984 | "domain": { 985 | "type": "string" 986 | } 987 | } 988 | }, 989 | "Estimation": { 990 | "type": "object", 991 | "properties": { 992 | "domains": { 993 | "type": "array", 994 | "items": { 995 | "type": "string" 996 | } 997 | }, 998 | "currency": { 999 | "type": "string" 1000 | } 1001 | } 1002 | }, 1003 | "EstimationV1": { 1004 | "type": "object", 1005 | "properties": { 1006 | "domain": { 1007 | "type": "string" 1008 | }, 1009 | "domain_idn": { 1010 | "type": "string" 1011 | }, 1012 | "currency": { 1013 | "type": "string" 1014 | }, 1015 | "exchangerate": { 1016 | "type": "number", 1017 | "format": "float" 1018 | }, 1019 | "estimation": { 1020 | "type": "number", 1021 | "format": "double" 1022 | }, 1023 | "quantity": { 1024 | "type": "integer", 1025 | "format": "int32" 1026 | }, 1027 | "features": { 1028 | "$ref": "#/definitions/EstimationParametersV1" 1029 | } 1030 | } 1031 | }, 1032 | "EstimationStatistics": { 1033 | "type": "object", 1034 | "properties": { 1035 | "queriesLast24Hours": { 1036 | "$ref": "#/definitions/StatisticsParameters" 1037 | }, 1038 | "queriesThisMonth": { 1039 | "$ref": "#/definitions/StatisticsParameters" 1040 | }, 1041 | "queriesThisYear": { 1042 | "$ref": "#/definitions/StatisticsParameters" 1043 | } 1044 | } 1045 | }, 1046 | "EstimationParameters": { 1047 | "type": "object", 1048 | "properties": { 1049 | "averageKeywordFrequency": { 1050 | "type": "string" 1051 | }, 1052 | "averageKeywordPrice": { 1053 | "type": "string" 1054 | }, 1055 | "averageLengthFrequency": { 1056 | "type": "string" 1057 | }, 1058 | "averageLengthPrice": { 1059 | "type": "string" 1060 | }, 1061 | "averageTldFrequency": { 1062 | "type": "string" 1063 | }, 1064 | "averageTldPrice": { 1065 | "type": "string" 1066 | }, 1067 | "char": { 1068 | "type": "string" 1069 | }, 1070 | "comDomain": { 1071 | "type": "string" 1072 | }, 1073 | "completelyNum": { 1074 | "type": "string" 1075 | }, 1076 | "foundKeywords": { 1077 | "type": "string" 1078 | }, 1079 | "foundPrefix": { 1080 | "type": "string" 1081 | }, 1082 | "foundSuffix": { 1083 | "type": "string" 1084 | }, 1085 | "hyph": { 1086 | "type": "string" 1087 | }, 1088 | "idnEncoding": { 1089 | "type": "string" 1090 | }, 1091 | "keywordCount": { 1092 | "type": "string" 1093 | }, 1094 | "majesticsGlobalRank": { 1095 | "type": "string" 1096 | }, 1097 | "majesticsPrevGlobalRank": { 1098 | "type": "string" 1099 | }, 1100 | "majesticsPrevRefIPs": { 1101 | "type": "string" 1102 | }, 1103 | "majesticsPrevRefSubNets": { 1104 | "type": "string" 1105 | }, 1106 | "majesticsPrevTldRank": { 1107 | "type": "string" 1108 | }, 1109 | "majesticsRefIPs": { 1110 | "type": "string" 1111 | }, 1112 | "majesticsRefSubNets": { 1113 | "type": "string" 1114 | }, 1115 | "majesticsTldRank": { 1116 | "type": "string" 1117 | }, 1118 | "nameSeg": { 1119 | "type": "string" 1120 | }, 1121 | "num": { 1122 | "type": "string" 1123 | }, 1124 | "numWords": { 1125 | "type": "string" 1126 | }, 1127 | "tld": { 1128 | "type": "string" 1129 | }, 1130 | "tldNumDomains": { 1131 | "type": "string" 1132 | } 1133 | } 1134 | }, 1135 | "EstimationParametersV1": { 1136 | "type": "object", 1137 | "properties": { 1138 | "nameBased": { 1139 | "type": "object", 1140 | "properties": { 1141 | "name": { 1142 | "type": "string" 1143 | }, 1144 | "pattern": { 1145 | "type": "string" 1146 | }, 1147 | "segements": { 1148 | "type": "array", 1149 | "items": { 1150 | "type": "string" 1151 | } 1152 | }, 1153 | "keywords": { 1154 | "type": "array", 1155 | "items": { 1156 | "type": "string" 1157 | } 1158 | }, 1159 | "numWords": { 1160 | "type": "string" 1161 | }, 1162 | "isIDN": { 1163 | "type": "boolean" 1164 | }, 1165 | "numDigits": { 1166 | "type": "number" 1167 | }, 1168 | "numHyph": { 1169 | "type": "number" 1170 | }, 1171 | "numChar": { 1172 | "type": "number" 1173 | }, 1174 | "completelyNum": { 1175 | "type": "number" 1176 | }, 1177 | "averageKeywordFrequency": { 1178 | "type": "number" 1179 | }, 1180 | "averageKeywordPrice": { 1181 | "type": "number" 1182 | }, 1183 | "averageLengthFrequency": { 1184 | "type": "number" 1185 | }, 1186 | "averageLengthPrice": { 1187 | "type": "number" 1188 | }, 1189 | "prefix": { 1190 | "type": "string" 1191 | }, 1192 | "averagePrefixFrequency": { 1193 | "type": "number" 1194 | }, 1195 | "averagePrefixPrice": { 1196 | "type": "number" 1197 | }, 1198 | "suffix": { 1199 | "type": "string" 1200 | }, 1201 | "averageSuffixFrequency": { 1202 | "type": "number" 1203 | }, 1204 | "averageSuffixPrice": { 1205 | "type": "number" 1206 | } 1207 | } 1208 | }, 1209 | "keywordBased": { 1210 | "type": "object", 1211 | "properties": { 1212 | "word": { 1213 | "type": "string" 1214 | }, 1215 | "version": { 1216 | "type": "string" 1217 | }, 1218 | "segments": { 1219 | "type": "array", 1220 | "items": { 1221 | "type": "string" 1222 | } 1223 | }, 1224 | "numWords": { 1225 | "type": "number" 1226 | }, 1227 | "keywords": { 1228 | "type": "array", 1229 | "items": { 1230 | "type": "string" 1231 | } 1232 | }, 1233 | "numKeywords": { 1234 | "type": "number" 1235 | }, 1236 | "averageKeywordFrequency": { 1237 | "type": "number" 1238 | }, 1239 | "averageKeywordPrice": { 1240 | "type": "number" 1241 | }, 1242 | "prefix\"": { 1243 | "type": "string" 1244 | }, 1245 | "averagePrefixFrequency": { 1246 | "type": "number" 1247 | }, 1248 | "averagePrefixPrice": { 1249 | "type": "number" 1250 | }, 1251 | "suffix": { 1252 | "type": "string" 1253 | }, 1254 | "averageSuffixFrequency": { 1255 | "type": "number" 1256 | }, 1257 | "averageSuffixPrice": { 1258 | "type": "number" 1259 | } 1260 | } 1261 | }, 1262 | "tldBased": { 1263 | "type": "object", 1264 | "properties": { 1265 | "tld": { 1266 | "type": "string" 1267 | }, 1268 | "subtld": { 1269 | "type": "string" 1270 | }, 1271 | "averageTldFrequency": { 1272 | "type": "number" 1273 | }, 1274 | "averageTldPrice": { 1275 | "type": "number" 1276 | }, 1277 | "averagSubtTldFrequency": { 1278 | "type": "number" 1279 | }, 1280 | "averageSubtldPrice": { 1281 | "type": "number" 1282 | }, 1283 | "tldNumDomains": { 1284 | "type": "number" 1285 | }, 1286 | "tldGlobaleRank": { 1287 | "type": "number" 1288 | }, 1289 | "subtldNumDomains": { 1290 | "type": "number" 1291 | }, 1292 | "subtldGlobaleRank": { 1293 | "type": "number" 1294 | }, 1295 | "languageTldMatch": { 1296 | "type": "number" 1297 | } 1298 | } 1299 | }, 1300 | "pagerank": { 1301 | "type": "object", 1302 | "properties": { 1303 | "globalRank": { 1304 | "type": "number" 1305 | }, 1306 | "tldRank": { 1307 | "type": "number" 1308 | }, 1309 | "refSubNets": { 1310 | "type": "number" 1311 | }, 1312 | "refIPs": { 1313 | "type": "number" 1314 | }, 1315 | "prevGlobalRank": { 1316 | "type": "number" 1317 | }, 1318 | "prevTldRank": { 1319 | "type": "number" 1320 | }, 1321 | "pPrevRefSubNets": { 1322 | "type": "number" 1323 | }, 1324 | "prevRefIPs": { 1325 | "type": "string" 1326 | } 1327 | } 1328 | }, 1329 | "language": { 1330 | "type": "object", 1331 | "properties": { 1332 | "en": { 1333 | "type": "number" 1334 | }, 1335 | "de": { 1336 | "type": "number" 1337 | }, 1338 | "fr": { 1339 | "type": "number" 1340 | }, 1341 | "it": { 1342 | "type": "number" 1343 | }, 1344 | "es": { 1345 | "type": "number" 1346 | } 1347 | } 1348 | }, 1349 | "wikipediaPageview": { 1350 | "type": "object", 1351 | "properties": { 1352 | "article": { 1353 | "type": "string" 1354 | }, 1355 | "averagePageviewsPerDay": { 1356 | "type": "string" 1357 | } 1358 | } 1359 | } 1360 | } 1361 | }, 1362 | "Majestic": { 1363 | "type": "object", 1364 | "properties": { 1365 | "ItemNu": { 1366 | "type": "string" 1367 | }, 1368 | "Item": { 1369 | "type": "string" 1370 | }, 1371 | "ResultCode": { 1372 | "type": "string" 1373 | }, 1374 | "Status": { 1375 | "type": "string" 1376 | }, 1377 | "ExtBackLinks": { 1378 | "type": "string" 1379 | }, 1380 | "RefDomains": { 1381 | "type": "string" 1382 | }, 1383 | "AnalysisResUnitsCost": { 1384 | "type": "string" 1385 | }, 1386 | "ACRank": { 1387 | "type": "string" 1388 | }, 1389 | "ItemType": { 1390 | "type": "string" 1391 | }, 1392 | "IndexedURLs": { 1393 | "type": "string" 1394 | }, 1395 | "GetTopBackLinksAnalysisResUnitsCost": { 1396 | "type": "string" 1397 | }, 1398 | "DownloadBacklinksAnalysisResUnitsCost": { 1399 | "type": "string" 1400 | }, 1401 | "DownloadRefDomainBacklinksAnalysisResUnitsCost": { 1402 | "type": "string" 1403 | }, 1404 | "RefIPs": { 1405 | "type": "string" 1406 | }, 1407 | "RefSubNets": { 1408 | "type": "string" 1409 | }, 1410 | "RefDomainsEDU": { 1411 | "type": "string" 1412 | }, 1413 | "ExtBackLinksEDU": { 1414 | "type": "string" 1415 | }, 1416 | "RefDomainsGOV": { 1417 | "type": "string" 1418 | }, 1419 | "ExtBackLinksGOV": { 1420 | "type": "string" 1421 | }, 1422 | "RefDomainsEDU_Exact": { 1423 | "type": "string" 1424 | }, 1425 | "ExtBackLinksEDU_Exact": { 1426 | "type": "string" 1427 | }, 1428 | "RefDomainsGOV_Exact": { 1429 | "type": "string" 1430 | }, 1431 | "ExtBackLinksGOV_Exact": { 1432 | "type": "string" 1433 | }, 1434 | "CrawledFlag": { 1435 | "type": "string" 1436 | }, 1437 | "LastCrawlDate": { 1438 | "type": "string" 1439 | }, 1440 | "LastCrawlResult": { 1441 | "type": "string" 1442 | }, 1443 | "RedirectFlag": { 1444 | "type": "string" 1445 | }, 1446 | "FinalRedirectResult": { 1447 | "type": "string" 1448 | }, 1449 | "OutDomainsExternal": { 1450 | "type": "string" 1451 | }, 1452 | "OutLinksExternal": { 1453 | "type": "string" 1454 | }, 1455 | "OutLinksInternal": { 1456 | "type": "string" 1457 | }, 1458 | "OutLinksPages": { 1459 | "type": "string" 1460 | }, 1461 | "LastSeen": { 1462 | "type": "string" 1463 | }, 1464 | "Title": { 1465 | "type": "string" 1466 | }, 1467 | "RedirectTo": { 1468 | "type": "string" 1469 | }, 1470 | "Language": { 1471 | "type": "string" 1472 | }, 1473 | "LanguageDesc": { 1474 | "type": "string" 1475 | }, 1476 | "LanguageConfidence": { 1477 | "type": "string" 1478 | }, 1479 | "LanguagePageRatios": { 1480 | "type": "string" 1481 | }, 1482 | "LanguageTotalPages": { 1483 | "type": "string" 1484 | }, 1485 | "RefLanguage": { 1486 | "type": "string" 1487 | }, 1488 | "RefLanguageDesc": { 1489 | "type": "string" 1490 | }, 1491 | "RefLanguageConfidence": { 1492 | "type": "string" 1493 | }, 1494 | "RefLanguagePageRatios": { 1495 | "type": "string" 1496 | }, 1497 | "RefLanguageTotalPages": { 1498 | "type": "string" 1499 | }, 1500 | "CrawledURLs": { 1501 | "type": "string" 1502 | }, 1503 | "RootDomainIPAddress": { 1504 | "type": "string" 1505 | }, 1506 | "TotalNonUniqueLinks": { 1507 | "type": "string" 1508 | }, 1509 | "NonUniqueLinkTypeHomepages": { 1510 | "type": "string" 1511 | }, 1512 | "NonUniqueLinkTypeIndirect": { 1513 | "type": "string" 1514 | }, 1515 | "NonUniqueLinkTypeDeleted": { 1516 | "type": "string" 1517 | }, 1518 | "NonUniqueLinkTypeNoFollow": { 1519 | "type": "string" 1520 | }, 1521 | "NonUniqueLinkTypeProtocolHTTPS": { 1522 | "type": "string" 1523 | }, 1524 | "NonUniqueLinkTypeFrame": { 1525 | "type": "string" 1526 | }, 1527 | "NonUniqueLinkTypeImageLink": { 1528 | "type": "string" 1529 | }, 1530 | "NonUniqueLinkTypeRedirect": { 1531 | "type": "string" 1532 | }, 1533 | "NonUniqueLinkTypeTextLink": { 1534 | "type": "string" 1535 | }, 1536 | "RefDomainTypeLive": { 1537 | "type": "string" 1538 | }, 1539 | "RefDomainTypeFollow": { 1540 | "type": "string" 1541 | }, 1542 | "RefDomainTypeHomepageLink": { 1543 | "type": "string" 1544 | }, 1545 | "RefDomainTypeDirect": { 1546 | "type": "string" 1547 | }, 1548 | "RefDomainTypeProtocolHTTPS": { 1549 | "type": "string" 1550 | }, 1551 | "CanonicalURL": { 1552 | "type": "string" 1553 | }, 1554 | "CitationFlow": { 1555 | "type": "string" 1556 | }, 1557 | "TrustFlow": { 1558 | "type": "string" 1559 | }, 1560 | "TrustMetric": { 1561 | "type": "string" 1562 | }, 1563 | "TopicalTrustFlow_Topic_0": { 1564 | "type": "string" 1565 | }, 1566 | "TopicalTrustFlow_Value_0": { 1567 | "type": "string" 1568 | }, 1569 | "TopicalTrustFlow_Topic_1": { 1570 | "type": "string" 1571 | }, 1572 | "TopicalTrustFlow_Value_1": { 1573 | "type": "string" 1574 | }, 1575 | "TopicalTrustFlow_Topic_2": { 1576 | "type": "string" 1577 | }, 1578 | "TopicalTrustFlow_Value_2": { 1579 | "type": "string" 1580 | } 1581 | } 1582 | }, 1583 | "ExchangeRate": { 1584 | "type": "object", 1585 | "properties": { 1586 | "currency": { 1587 | "type": "string" 1588 | }, 1589 | "rate": { 1590 | "type": "number" 1591 | } 1592 | } 1593 | }, 1594 | "HistoryUser": { 1595 | "type": "object", 1596 | "properties": { 1597 | "id": { 1598 | "type": "integer" 1599 | }, 1600 | "domain": { 1601 | "type": "string" 1602 | }, 1603 | "execution_time": { 1604 | "type": "string" 1605 | }, 1606 | "price": { 1607 | "type": "string" 1608 | }, 1609 | "data": { 1610 | "type": "string" 1611 | }, 1612 | "ip": { 1613 | "type": "string" 1614 | }, 1615 | "user": { 1616 | "type": "string" 1617 | }, 1618 | "request_type": { 1619 | "type": "string" 1620 | }, 1621 | "created_at": { 1622 | "type": "string" 1623 | }, 1624 | "updated_at": { 1625 | "type": "string" 1626 | } 1627 | } 1628 | }, 1629 | "Keyword": { 1630 | "type": "object", 1631 | "properties": { 1632 | "competition": { 1633 | "type": "number", 1634 | "format": "double" 1635 | }, 1636 | "keyword": { 1637 | "type": "string" 1638 | }, 1639 | "cpc": { 1640 | "type": "string" 1641 | }, 1642 | "vol": { 1643 | "type": "string" 1644 | } 1645 | } 1646 | }, 1647 | "Keywords": { 1648 | "type": "object", 1649 | "properties": { 1650 | "keywords": { 1651 | "type": "array", 1652 | "items": { 1653 | "type": "string" 1654 | } 1655 | } 1656 | } 1657 | }, 1658 | "Meta": { 1659 | "type": "object", 1660 | "properties": { 1661 | "online": { 1662 | "type": "boolean" 1663 | }, 1664 | "dnssec": { 1665 | "type": "boolean" 1666 | }, 1667 | "description": { 1668 | "type": "string" 1669 | }, 1670 | "title": { 1671 | "type": "string" 1672 | }, 1673 | "certificateIssure": { 1674 | "type": "string" 1675 | }, 1676 | "certificateValid": { 1677 | "type": "boolean" 1678 | }, 1679 | "ipv4": { 1680 | "type": "array", 1681 | "items": { 1682 | "type": "string" 1683 | } 1684 | }, 1685 | "ipv6": { 1686 | "type": "array", 1687 | "items": { 1688 | "type": "string" 1689 | } 1690 | }, 1691 | "mx": { 1692 | "type": "array", 1693 | "items": { 1694 | "type": "string" 1695 | } 1696 | }, 1697 | "ns": { 1698 | "type": "array", 1699 | "items": { 1700 | "type": "string" 1701 | } 1702 | } 1703 | } 1704 | }, 1705 | "UserEstimationStatistics": { 1706 | "type": "object", 1707 | "properties": { 1708 | "queriesLast24Hours": { 1709 | "$ref": "#/definitions/StatisticsParameters" 1710 | }, 1711 | "queriesThisMonth": { 1712 | "$ref": "#/definitions/StatisticsParameters" 1713 | }, 1714 | "queriesThisYear": { 1715 | "$ref": "#/definitions/StatisticsParameters" 1716 | }, 1717 | "last12MonthsDevelopment": { 1718 | "type": "object", 1719 | "properties": { 1720 | "totalQueries": { 1721 | "type": "object" 1722 | }, 1723 | "webQueries": { 1724 | "type": "object" 1725 | }, 1726 | "apiQueries": { 1727 | "type": "object" 1728 | } 1729 | } 1730 | } 1731 | } 1732 | }, 1733 | "Sistrix": { 1734 | "type": "object", 1735 | "properties": { 1736 | "sichtbarkeitsindex": { 1737 | "type": "string" 1738 | }, 1739 | "pages": { 1740 | "type": "integer" 1741 | }, 1742 | "kwcount_seo": { 1743 | "type": "integer" 1744 | }, 1745 | "kwcount_sem": { 1746 | "type": "integer" 1747 | } 1748 | } 1749 | }, 1750 | "SocialMedia": { 1751 | "type": "object", 1752 | "properties": { 1753 | "facebook": { 1754 | "type": "boolean" 1755 | }, 1756 | "instagram": { 1757 | "type": "boolean" 1758 | }, 1759 | "pinterest": { 1760 | "type": "boolean" 1761 | }, 1762 | "twitter": { 1763 | "type": "boolean" 1764 | }, 1765 | "youtube": { 1766 | "type": "boolean" 1767 | } 1768 | } 1769 | }, 1770 | "Platform" : { 1771 | "type" : "string", 1772 | "enum" : [ "FACEBOOK", "TWITTER", "PINTEREST", "YOUTUBE", "TIKTOK", "GITHUB", "TWITCH", "VIMEO", "VK" ] 1773 | }, 1774 | "StatisticsParameters": { 1775 | "type": "object", 1776 | "properties": { 1777 | "totalQueries": { 1778 | "type": "number", 1779 | "format": "integer" 1780 | }, 1781 | "webQueries": { 1782 | "type": "number", 1783 | "format": "integer" 1784 | }, 1785 | "apiQueries": { 1786 | "type": "number", 1787 | "format": "integer" 1788 | }, 1789 | "queryPercentage": { 1790 | "type": "number", 1791 | "format": "integer" 1792 | } 1793 | } 1794 | }, 1795 | "SimilarDomain": { 1796 | "type": "object", 1797 | "properties": { 1798 | "relatedDomainPrice": { 1799 | "type": "number", 1800 | "format": "double" 1801 | }, 1802 | "relatedDomains": { 1803 | "type": "string" 1804 | } 1805 | } 1806 | }, 1807 | "Wayback": { 1808 | "type": "object", 1809 | "properties": { 1810 | "wayback": { 1811 | "type": "object", 1812 | "properties": { 1813 | "url": { 1814 | "type": "string" 1815 | }, 1816 | "archived_snapshots": { 1817 | "type": "object", 1818 | "properties": { 1819 | "closest": { 1820 | "type": "object", 1821 | "properties": { 1822 | "status": { 1823 | "type": "string" 1824 | }, 1825 | "available": { 1826 | "type": "boolean" 1827 | }, 1828 | "url": { 1829 | "type": "string" 1830 | }, 1831 | "timestamp": { 1832 | "type": "string" 1833 | } 1834 | } 1835 | } 1836 | } 1837 | } 1838 | } 1839 | } 1840 | } 1841 | } 1842 | } 1843 | } --------------------------------------------------------------------------------