swagger: '2.0' info: description: >- The Word Associations Network API allows developers to embed the ability to find associations for a word or phrase into their mobile apps or web services. Words are grouped by semantics, meaning, and psychological perception. The Word Associations Network API currently supports English, French, Spanish, German, Italian, Portuguese, and Russian vocabulary. Please [register and subscribe](https://api.wordassociations.net/subscriptions/) to one of available tariff plans to get a valid API key. version: '1.0' title: Word Associations API termsOfService: 'https://wordassociations.net/en/api' contact: email: contact@wordassociations.net host: api.wordassociations.net schemes: - https basePath: /associations/v1.0 consumes: - application/x-www-form-urlencoded produces: - application/json securityDefinitions: internalApiKey: type: apiKey name: apikey in: query description: >- API key. Please register and subscribe to one of available tariff plans to get a valid API key https://api.wordassociations.net/subscriptions/. security: - internalApiKey: [] paths: /json/search: get: description: | Gets associations with the given word or phrase. produces: - application/json parameters: - name: text in: query description: > Word or phrase to find associations with. Tip. You can use multiple parameters 'text' in a request (from 1 to 10 inclusive). This way you can get associations for several input words or phrases in one response. Restriction: regardless of the size of the text association lookup is always performed by the first 10 words of the text. required: true type: array items: type: string collectionFormat: multi minItems: 1 maxItems: 10 - name: lang in: query description: | Query language. Use language code for the language of the text: * de - German; * en - English; * es - Spanish; * fr - French; * it - Italian; * pt - Portuguese; * ru - Russian; required: true type: string enum: - de - en - es - fr - it - pt - ru - name: type in: query description: > Type of result. Possible values: * stimulus - an input data (the text parameter) is considered as a response word. The service returns a list of stimuli words, which evoke a given response word; * response - an input data (the text parameter) is considered as a stimulus word. The service returns a list of response words, which come to mind for a given stimulus word. required: false type: string enum: - stimulus - response default: stimulus - name: limit in: query description: > Maximum number of results to return. Allows to limit the number of results (associations) in response. The value of this parameter is an integer number from 1 to 300 inclusive. required: false type: integer minimum: 1 maximum: 300 default: 50 - name: pos in: query description: > Parts of speech to return. Allows to limit results by specified parts of speech. The value of this parameter is a list of parts of speech separated by comma. The following parts of speech codes are supported: * noun * adjective * verb * adverb required: false type: array items: type: string collectionFormat: csv enum: - noun - adjective - verb - adverb default: - noun - adjective - verb - adverb - name: indent in: query description: | Indentation switch for pretty printing of JSON response. Allows to either turn on or off space indentation for a response. The following values are allowed: * yes - turns indentation with spaces on; * no - turn indentation with spaces off; required: false type: string enum: - 'yes' - 'no' default: 'yes' responses: '200': description: Successful response schema: $ref: '#/definitions/Body' '401': description: Invalid API key '429': description: The monthly limit on the number of requests is exceeded '501': description: The specified language is not supported post: description: | Gets associations with the given word or phrase. consumes: - application/x-www-form-urlencoded produces: - application/json parameters: - name: text in: formData description: > Word or phrase to find associations with. Tip. You can use multiple parameters 'text' in a request (from 1 to 10 inclusive). This way you can get associations for several input words or phrases in one response. Restriction: regardless of the size of the text association lookup is always performed by the first 10 words of the text. required: true type: array items: type: string collectionFormat: multi minItems: 1 maxItems: 10 - name: lang in: formData description: | Query language. Use language code for the language of the text: * de - German; * en - English; * es - Spanish; * fr - French; * it - Italian; * pt - Portuguese; * ru - Russian; required: true type: string enum: - de - en - es - fr - it - pt - ru - name: type in: formData description: > Type of result. Possible values: * stimulus - an input data (the text parameter) is considered as a response word. The service returns a list of stimuli words, which evoke a given response word; * response - an input data (the text parameter) is considered as a stimulus word. The service returns a list of response words, which come to mind for a given stimulus word. required: false type: string enum: - stimulus - response default: stimulus - name: limit in: formData description: > Maximum number of results to return. Allows to limit the number of results (associations) in response. The value of this parameter is an integer number from 1 to 300 inclusive. required: false type: integer minimum: 1 maximum: 300 default: 50 - name: pos in: formData description: > Parts of speech to return. Allows to limit results by specified parts of speech. The value of this parameter is a list of parts of speech separated by comma. The following parts of speech codes are supported: * noun * adjective * verb * adverb required: false type: array items: type: string collectionFormat: csv enum: - noun - adjective - verb - adverb default: - noun - adjective - verb - adverb - name: indent in: formData description: | Indentation switch for pretty printing of JSON response. Allows to either turn on or off space indentation for a response. The following values are allowed: * yes - turns indentation with spaces on; * no - turn indentation with spaces off; required: false type: string enum: - 'yes' - 'no' default: 'yes' responses: '200': description: Successful response schema: $ref: '#/definitions/Body' '401': description: Invalid API key '429': description: The monthly limit on the number of requests is exceeded '501': description: The specified language is not supported definitions: Body: type: object properties: version: type: string code: type: integer format: int32 request: $ref: '#/definitions/Request' response: type: array items: $ref: '#/definitions/Response' Request: type: object properties: text: type: array items: type: string lang: type: string type: type: string limit: type: integer pos: type: string indent: type: string Response: type: object properties: text: type: string items: type: array items: $ref: '#/definitions/Item' Item: type: object properties: item: type: string weight: type: number pos: type: string