> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blockscout.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List of MUD worlds.

> Retrieves a paginated list of MUD worlds with basic stats.



## OpenAPI

````yaml /openapi-specs/pro-api-v11.yaml get /v2/mud/worlds
openapi: 3.0.0
info:
  contact:
    email: info@blockscout.com
  title: Blockscout
  version: 11.0.3
servers:
  - url: http://localhost/api
    variables: {}
security: []
tags:
  - name: blocks
  - name: transactions
  - name: addresses
  - name: internal-transactions
  - name: tokens
  - name: token-transfers
  - name: smart-contracts
  - name: config
  - name: main-page
  - name: search
  - name: stats
  - name: csv-export
  - name: account-abstraction
  - name: withdrawals
  - name: advanced-filters
  - name: arbitrum
  - name: legacy
  - name: optimism
  - name: mud
  - name: celo
  - name: scroll
  - name: zilliqa
paths:
  /v2/mud/worlds:
    get:
      tags:
        - mud
      summary: List of MUD worlds.
      description: Retrieves a paginated list of MUD worlds with basic stats.
      operationId: BlockScoutWeb.API.V2.MudController.worlds
      parameters:
        - description: API key for rate limiting or for sensitive endpoints
          in: query
          name: apikey
          required: false
          schema:
            type: string
            x-struct: null
            x-validate: null
        - description: Secret key for getting access to restricted resources
          in: query
          name: key
          required: false
          schema:
            type: string
            x-struct: null
            x-validate: null
        - description: MUD world address hash for paging
          in: query
          name: world
          required: false
          schema:
            $ref: '#/components/schemas/AddressHash'
        - description: Number of items returned per page
          in: query
          name: items_count
          required: false
          schema:
            maximum: 50
            minimum: 1
            type: integer
            x-struct: null
            x-validate: null
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                nullable: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/World'
                    nullable: false
                    type: array
                    x-struct: null
                    x-validate: null
                  next_page_params:
                    example:
                      items_count: 50
                      world: '0x82cb040ff4463bff3395d52b558fd77c61583b27'
                    nullable: true
                    type: object
                    x-struct: null
                    x-validate: null
                required:
                  - items
                  - next_page_params
                type: object
                x-struct: null
                x-validate: null
          description: List of MUD worlds.
      callbacks: {}
components:
  schemas:
    AddressHash:
      nullable: false
      pattern: ^0x([A-Fa-f0-9]{40})$
      title: AddressHash
      type: string
      x-struct: Elixir.BlockScoutWeb.Schemas.API.V2.General.AddressHash
      x-validate: null
    World:
      additionalProperties: false
      description: MUD World struct.
      nullable: false
      properties:
        address:
          additionalProperties: false
          description: Address
          properties:
            ens_domain_name:
              description: ENS domain name associated with the address
              nullable: true
              type: string
              x-struct: null
              x-validate: null
            hash:
              $ref: '#/components/schemas/AddressHash'
            implementations:
              description: Implementations linked with the contract
              items:
                $ref: '#/components/schemas/Implementation'
              type: array
              x-struct: null
              x-validate: null
            is_contract:
              description: Has address contract code?
              nullable: true
              type: boolean
              x-struct: null
              x-validate: null
            is_scam:
              description: Has address scam badge?
              nullable: false
              type: boolean
              x-struct: null
              x-validate: null
            is_verified:
              description: Has address associated source code?
              nullable: true
              type: boolean
              x-struct: null
              x-validate: null
            metadata:
              allOf:
                - $ref: '#/components/schemas/Metadata'
              nullable: true
              x-struct: null
              x-validate: null
            name:
              description: Name associated with the address
              nullable: true
              type: string
              x-struct: null
              x-validate: null
            private_tags:
              description: Private tags associated with the address
              items:
                $ref: '#/components/schemas/Tag'
              type: array
              x-struct: null
              x-validate: null
            proxy_type:
              $ref: '#/components/schemas/ProxyType'
            public_tags:
              description: Public tags associated with the address
              items:
                $ref: '#/components/schemas/Tag'
              type: array
              x-struct: null
              x-validate: null
            reputation:
              description: Reputation of the address
              enum:
                - ok
                - scam
              nullable: false
              type: string
              x-struct: null
              x-validate: null
            watchlist_names:
              description: Watchlist name associated with the address
              items:
                $ref: '#/components/schemas/WatchlistName'
              type: array
              x-struct: null
              x-validate: null
          required:
            - hash
            - is_contract
            - name
            - is_scam
            - reputation
            - proxy_type
            - implementations
            - is_verified
            - ens_domain_name
            - metadata
          title: Address
          type: object
          x-struct: Elixir.BlockScoutWeb.Schemas.API.V2.Address
          x-validate: null
        coin_balance:
          $ref: '#/components/schemas/IntegerStringNullable'
        transactions_count:
          nullable: true
          type: integer
          x-struct: null
          x-validate: null
      required:
        - address
        - coin_balance
        - transactions_count
      title: World
      type: object
      x-struct: Elixir.BlockScoutWeb.Schemas.API.V2.MUD.World
      x-validate: null
    Implementation:
      additionalProperties: false
      description: Proxy smart contract implementation
      properties:
        address_hash:
          $ref: '#/components/schemas/AddressHash'
        name:
          nullable: true
          type: string
          x-struct: null
          x-validate: null
      required:
        - address_hash
        - name
      title: Implementation
      type: object
      x-struct: Elixir.BlockScoutWeb.Schemas.API.V2.General.Implementation
      x-validate: null
    Metadata:
      additionalProperties: false
      description: Metadata struct
      properties:
        tags:
          description: Metadata tags linked with the address
          items:
            $ref: '#/components/schemas/MetadataTag'
          type: array
          x-struct: null
          x-validate: null
      required:
        - tags
      title: Metadata
      type: object
      x-struct: Elixir.BlockScoutWeb.Schemas.API.V2.Proxy.Metadata
      x-validate: null
    Tag:
      additionalProperties: false
      description: Address tag struct
      properties:
        address_hash:
          $ref: '#/components/schemas/AddressHash'
        display_name:
          nullable: false
          type: string
          x-struct: null
          x-validate: null
        label:
          nullable: false
          type: string
          x-struct: null
          x-validate: null
      required:
        - address_hash
        - display_name
        - label
      title: Tag
      type: object
      x-struct: Elixir.BlockScoutWeb.Schemas.API.V2.General.Tag
      x-validate: null
    ProxyType:
      enum:
        - eip1167
        - eip1967
        - eip1822
        - eip1967_oz
        - eip1967_beacon
        - master_copy
        - basic_implementation
        - basic_get_implementation
        - comptroller
        - eip2535
        - clone_with_immutable_arguments
        - eip7702
        - resolved_delegate_proxy
        - erc7760
      nullable: true
      title: ProxyType
      type: string
      x-struct: Elixir.BlockScoutWeb.Schemas.API.V2.General.ProxyType
      x-validate: null
    WatchlistName:
      additionalProperties: false
      description: Watchlist name struct
      properties:
        display_name:
          nullable: false
          type: string
          x-struct: null
          x-validate: null
        label:
          nullable: false
          type: string
          x-struct: null
          x-validate: null
      required:
        - display_name
        - label
      title: WatchlistName
      type: object
      x-struct: Elixir.BlockScoutWeb.Schemas.API.V2.General.WatchlistName
      x-validate: null
    IntegerStringNullable:
      nullable: true
      pattern: ^-?([1-9][0-9]*|0)$
      title: IntegerStringNullable
      type: string
      x-struct: Elixir.BlockScoutWeb.Schemas.API.V2.General.IntegerStringNullable
      x-validate: null
    MetadataTag:
      additionalProperties: false
      description: Metadata tag struct
      properties:
        meta:
          nullable: false
          type: object
          x-struct: null
          x-validate: null
        name:
          nullable: false
          type: string
          x-struct: null
          x-validate: null
        ordinal:
          nullable: false
          type: integer
          x-struct: null
          x-validate: null
        slug:
          nullable: false
          type: string
          x-struct: null
          x-validate: null
        tagType:
          nullable: false
          type: string
          x-struct: null
          x-validate: null
      required:
        - slug
        - name
        - tagType
        - ordinal
        - meta
      title: MetadataTag
      type: object
      x-struct: Elixir.BlockScoutWeb.Schemas.API.V2.Proxy.MetadataTag
      x-validate: null

````