Botify

Botify User API

The User API from Botify — 1 operation(s) for user.

GitHub OpenAPI

Operations 1

GET /projects/{username} Get user projects #

Documentation

📖
Documentation
https://developers.botify.com/docs/welcome-to-botifys-api-documentation
📖
APIReference
https://developers.botify.com/reference/getalluserprojects-1
📖
GettingStarted
https://developers.botify.com/docs/getting-started
📖
Authentication
https://artifacts.apis.io/botify/authentication/botify-authentication.yml
📖
RateLimits
https://developers.botify.com/docs/limits

Specifications

⚙
OpenAPI
https://artifacts.apis.io/botify/openapi/botify-user-api-openapi.yml

Other Resources

🔗
Conventions
https://artifacts.apis.io/botify/conventions/botify-conventions.yml
🔗
ErrorCatalog
https://artifacts.apis.io/botify/errors/botify-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/botify/data-model/botify-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/botify:botify-user-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

botify-user-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Botify User API
  version: 1.0.0
  x-refined-note:
  - x-codegen-settings differs across the merged source definitions and was not carried
  description: 'Operations tagged User across 2 of this provider''s published API definitions: botify-api-swagger.json, botify-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.botify.com/v1
security:
- DjangoRestToken: []
tags:
- name: User
paths:
  /projects/{username}:
    parameters:
    - name: username
      in: path
      required: true
      description: User's identifier
      schema:
        type: string
    get:
      description: List all active projects for the user
      summary: Get user projects
      operationId: getUserProjects
      tags:
      - User
      parameters:
      - in: query
        name: name
        description: Project's name
        schema:
          type: string
      - in: query
        name: page
        description: Page Number
        required: false
        schema:
          type: integer
          default: 1
      - in: query
        name: size
        description: Page Size
        required: false
        schema:
          type: integer
      responses:
        default:
          description: error payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultPayload'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  next:
                    type: string
                  previous:
                    type: string
                  count:
                    type: integer
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Project'
                  page:
                    type: integer
                  size:
                    type: integer
      x-summary-source: derived
    servers:
    - url: https://api.botify.com/v1
components:
  schemas:
    ProjectSettings:
      properties:
        blacklisted_domains:
          type: array
          items:
            type: string
        allowed_domains:
          type: array
          items:
            type: string
        pk:
          type: string
          readOnly: true
      type: object
      required:
      - blacklisted_domains
      - allowed_domains
    DefaultPayload:
      type: object
      description: default payload for object for all HTTP codes that are not covered individually
      properties:
        error:
          type: object
          properties:
            message:
              description: Error Message
              type: string
            error_code:
              description: Error Code
              type: string
            error_detail:
              description: If available, detailed error
              type: object
    WebProperty:
      properties:
        public_id:
          type: string
        name:
          type: string
        domain:
          type: string
        current_subscription_plan:
          $ref: '#/components/schemas/SubscriptionPlan'
        renewal_subscription_plan:
          $ref: '#/components/schemas/SubscriptionPlan'
      type: object
      required:
      - public_id
      - name
      - domain
      - current_subscription_plan
      - renewal_subscription_plan
    OrganizationUser:
      properties:
        owner:
          $ref: '#/components/schemas/User'
        name:
          type: string
          readOnly: true
        slug:
          type: string
          readOnly: true
        is_organization:
          type: string
          readOnly: true
        email:
          type: string
          readOnly: true
      type: object
      required:
      - owner
    SubscriptionPlan:
      properties:
        plan:
          type: string
        start_date:
          type: string
          format: date-time
        data_retention:
          type: string
          readOnly: true
        alert_panel:
          type: string
          readOnly: true
        smart_activation:
          type: string
          readOnly: true
      type: object
      required:
      - plan
      - start_date
    User:
      properties:
        username:
          type: string
          description: Required. 30 characters or fewer. Letters, numbers and /-/_/. characters
        first_name:
          type: string
        last_name:
          type: string
        email:
          type: string
        full_name:
          type: string
          readOnly: true
      type: object
      required:
      - username
    Project:
      properties:
        pk:
          type: string
          readOnly: true
        name:
          type: string
        slug:
          type: string
        organization:
          $ref: '#/components/schemas/OrganizationUser'
        current_settings:
          $ref: '#/components/schemas/ProjectSettings'
        date_created:
          type: string
          readOnly: true
        url:
          type: string
          readOnly: true
        permissions:
          type: string
          readOnly: true
        roles:
          type: string
          readOnly: true
        last_log_revision:
          type: string
          readOnly: true
        last_crawls_revisions:
          type: string
          readOnly: true
        last_actionboard_revision:
          type: string
          readOnly: true
        has_actionboard_changes:
          type: string
          readOnly: true
        has_crawl:
          type: boolean
        has_logs:
          type: boolean
        has_keywords:
          type: string
          readOnly: true
        max_gsc_websites:
          type: integer
          format: int64
          minimum: 0
          maximum: 32767
        max_gsc_via_bq_websites:
          type: integer
          format: int64
          description: Maximum number of GSC properties that can be activated using BigQuery bulk export
          minimum: 0
          maximum: 32767
        realkeywords_aggregation_type:
          type: integer
          format: int64
          description: 'If ''New: By website & by URL'' is selected, data will be shown aggregated by website wherever possible in RealKeywords'
        actionboard_enabled:
          type: boolean
        has_actionboard:
          type: string
          readOnly: true
        has_engagement_analytics:
          type: boolean
        public_id:
          type: integer
          format: int64
          minimum: -9223372036854775808
          maximum: 9223372036854775807
        account_id:
          type: string
          readOnly: true
        mcp:
          type: string
          readOnly: true
        has_alertpanel:
          type: string
          readOnly: true
        has_speedworkers:
          type: string
          readOnly: true
        has_pageworkers:
          type: string
          readOnly: true
        has_smartcontent:
          type: string
          readOnly: true
        has_smartlink:
          type: string
          readOnly: true
        has_agentic_catalog:
          type: string
          readOnly: true
        has_gen_ai:
          type: boolean
        has_ai_consent:
          type: string
          readOnly: true
        has_web_vitals_field_data:
          type: boolean
        max_extracts:
          type: integer
          format: int64
        category:
          type: string
          default: 0
        webproperty:
          $ref: '#/components/schemas/WebProperty'
      type: object
      required:
      - name
      - slug
      - organization
      - current_settings
      - has_crawl
      - has_logs
      - actionboard_enabled
      - has_engagement_analytics
      - has_gen_ai
      - has_web_vitals_field_data
      - max_extracts
      - webproperty
    ProjectSettingsSerializer:
      required:
      - start_urls
      - max_nb_pages
      - blacklisted_domains
      - allowed_domains
      - sitemaps
      - header_settings
      type: object
      properties:
        start_urls:
          description: ''
          items:
            type: string
          readOnly: false
          type: array
        max_nb_pages:
          description: ''
          format: int64
          maximum: 2147483647
          readOnly: false
          minimum: 1
          type: integer
        max_depth:
          description: ''
          format: int64
          maximum: 2147483647
          readOnly: false
          minimum: 0
          type: integer
        compare_crawl:
          readOnly: false
          type: boolean
          description: ''
        blacklisted_domains:
          description: ''
          items:
            type: string
          readOnly: false
          type: array
        allowed_domains:
          description: ''
          items:
            type: string
          readOnly: false
          type: array
        respect_nofollow:
          readOnly: false
          type: boolean
          description: ''
        crawl_gzip:
          readOnly: false
          type: boolean
          description: ''
        has_robots_txt:
          readOnly: true
          type: string
          description: ''
        user_agent:
          readOnly: false
          type: string
          description: ''
        max_pages_per_sec:
          description: ''
          format: int64
          maximum: 2147483647
          readOnly: false
          minimum: 1
          type: integer
        extra_headers:
          readOnly: false
          type: string
          description: ''
        google_social_auth_id:
          description: ''
          format: int64
          maximum: 2147483647
          readOnly: false
          minimum: -2147483648
          type: integer
        google_analytics_site_id:
          description: ''
          format: int64
          maximum: 2147483647
          readOnly: false
          minimum: -2147483648
          type: integer
        google_analytics_account_email:
          readOnly: false
          type: string
          description: Keep email in case user delete his social auth connection
        google_analytics_nb_days:
          description: ''
          format: int64
          maximum: 90
          readOnly: false
          minimum: 1
          type: integer
        sitemaps:
          description: ''
          items:
            type: string
          readOnly: false
          type: array
        header_settings:
          description: ''
          items:
            type: string
          readOnly: false
          type: array
    User_2:
      type: object
      properties:
        login:
          readOnly: true
          type: string
          description: ''
        email:
          readOnly: false
          type: string
          description: ''
        is_organization:
          readOnly: true
          type: string
          description: ''
        url:
          readOnly: true
          type: string
          description: ''
        date_joined:
          readOnly: false
          type: string
          description: ''
          format: date-time
        status:
          readOnly: false
          type: string
          description: ''
        first_name:
          readOnly: false
          type: string
          description: ''
        last_name:
          readOnly: false
          type: string
          description: ''
        company_name:
          readOnly: false
          type: string
          description: ''
    Project_2:
      required:
      - name
      - slug
      - user
      - current_settings
      type: object
      properties:
        name:
          readOnly: false
          type: string
          description: ''
        slug:
          readOnly: false
          type: string
          description: ''
        user:
          readOnly: false
          description: ''
          $ref: '#/components/schemas/User_2'
        current_settings:
          readOnly: false
          description: ''
          $ref: '#/components/schemas/ProjectSettingsSerializer'
        active:
          readOnly: false
          type: boolean
          description: ''
        date_created:
          readOnly: true
          type: string
          description: ''
  securitySchemes:
    DjangoRestToken:
      type: apiKey
      name: Authorization
      in: header
x-refined-from:
- botify-api-swagger.json
- botify-openapi.json