# Users End users related endpoints ## Get users with similar activity as the given user > Returns a list of users with similar history activity to the given user.\ > \ > {% hint style="info" %}\ > \ > \## Similar example\ > \ > \ > In this example we get 10 users with similar activity to the user with id 100984.\ > \ > \`\`\`bash\ > $ curl --request GET \\\ > \--url ' > \`\`\`\ > \ > {% endhint %}\
````json {"openapi":"3.0.1","info":{"title":"","version":"0.1.0"},"tags":[{"description":"End users related endpoints","name":"Users"}],"servers":[{"description":"Production API","url":"https://api.vaix.ai"},{"description":"Staging (integration) API","url":"https://staging-api.vaix.ai"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"scheme":"bearer","type":"http"}},"schemas":{"OperatorUser":{"additionalProperties":false,"description":"An API user object","properties":{"age":{"description":"The age of the user. Can be `null` if no birthdate is provided.","type":"integer"},"apds":{"description":"Number of APDs for the user","nullable":true,"type":"integer"},"country":{"description":"The country of the user","type":"string"},"current_frequency_segment":{"description":"The current frequency segment","nullable":true,"type":"string"},"current_value_segment":{"description":"The current value segment","nullable":true,"type":"string"},"first_bet_at":{"description":"The delivery date of the first bet placed by the user","nullable":true,"type":"string"},"first_wager_at":{"description":"The starting date of the first game session played by the user","nullable":true,"type":"string"},"gender":{"description":"The gender of the user if existing","nullable":true,"type":"string"},"ggr":{"description":"The Gross Gaming Revenue of the user","nullable":true,"type":"string"},"product":{"description":"The product the predictions refer to (e.g. sports, casino)","type":"string"},"registration_date":{"description":"The datetime the user registered","type":"string"},"state":{"description":"The state of the user","type":"string"},"total_prize":{"description":"The total prize of the user","nullable":true,"type":"string"},"total_stake":{"description":"The total stake of the user","nullable":true,"type":"string"},"user_id":{"description":"The user's id","type":"string"}},"type":"object"},"Error":{"additionalProperties":false,"description":"The generic API's error response","properties":{"error":{"description":"Description of the error","type":"string"},"status":{"description":"response status","type":"string"}},"type":"object"},"Errors":{"additionalProperties":false,"description":"The generic API's errors response","properties":{"errors":{"description":"An object with the request errors","type":"object"}},"type":"object"},"UnprocessableEntityError":{"oneOf":[{"additionalProperties":false,"description":"The generic API's error response","properties":{"error":{"description":"Description of the error","type":"string"},"status":{"description":"response status","type":"string"}},"type":"object"},{"additionalProperties":false,"description":"The generic API's errors response","properties":{"errors":{"description":"An object with the request errors","type":"object"}},"type":"object"}]}}},"paths":{"/api/sports/users/similar":{"get":{"description":"Returns a list of users with similar history activity to the given user.\n\n{% hint style=\"info\" %}\n\n## Similar example\n\n\nIn this example we get 10 users with similar activity to the user with id 100984.\n\n```bash\n$ curl --request GET \\\n--url 'http://localhost:4001/api/sports/users/similar?user_id=100984&operator=bet25&count=10'\n```\n\n{% endhint %}\n\n","operationId":"get_similar_users","parameters":[{"description":"Custom client header, the value should be the name of the group the user belongs to","in":"header","name":"x-vaix-client-id","required":true,"schema":{"type":"string"}},{"description":"Authentication method to be used, supported values [`vaix`, `iam`]. Defaults to `vaix`","in":"header","name":"x-vaix-authentication-method","required":false,"schema":{"type":"string"}},{"description":"The operator to use for querying data. Notice that this is applied only\nif your account has access to multiple operators. In a different case\nthe assigned operator to your account is used and the value of this\nfield is ignored.\n","in":"query","name":"operator","required":false,"schema":{"type":"string"}},{"description":"The bookmaker id to use for querying data. Notice that this is applied only\nif your account has access to multiple operators. In a different case\nthe assigned operator to your account is used and the value of this\nfield is ignored. Note that this parameter is used together with the\n`sub_bookmaker_id` parameter.\n","in":"query","name":"bookmaker_id","required":false,"schema":{"type":"integer"}},{"description":"The sub-bookmaker id to use for querying data. Notice that this is applied only\nif your account has access to multiple operators. In a different case\nthe assigned operator to your account is used and the value of this\nfield is ignored. Note that this parameter is used together with the\n`bookmaker_id` parameter.\n","in":"query","name":"sub_bookmaker_id","required":false,"schema":{"type":"integer"}},{"description":"The user to get similar users for.","in":"query","name":"user_id","required":true,"schema":{"type":"string"}},{"description":"How many similar users to return.","in":"query","name":"count","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"API response","properties":{"data":{"$ref":"#/components/schemas/OperatorUser"},"status":{"description":"The status of the request","enum":["success","error"],"type":"string"}},"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not Found"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Not Acceptable"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Request Entity Too Large"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityError"}}},"description":"Unprocessable Entity"},"425":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Too Early"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal Server Error"}},"summary":"Get users with similar activity as the given user","tags":["Users"]}}}} ```` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.sportradar.com/personalization/api-reference/sports/users.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.