API Docs
DocsGithubSupportMeroku Protocol
  • About
  • API reference
    • Dapp
      • DeleteApp
      • Upload
      • Build
      • Rate
      • SearchById
      • Categories
    • Store
      • Featured
        • Dapps
      • DeleteStore
      • BannedDapps
      • Dapp
      • Title
        • /
    • App
      • Installed
      • InstallUrl
    • O
      • View
      • Download
    • Domainverification
      • GetVerificationId
      • Verify
    • Api
      • V1
        • Dapp
          • Search
          • Autocomplete
  • Specification
  • SDK
    • NodeJS
  • ../Meroku Docs
Powered by GitBook
On this page
  1. API reference

Dapp

PreviousAPI referenceNextDeleteApp

Last updated 2 years ago

  • GETGet dApp
  • POSTAdd dApp
  • PUTUpdate dApp

Get dApp

get

Get all dApps or search by a keyword. Optionally, filter on specific attributes of the dApp.

This API call will get all the dApps or perform a text search.

Query parameters
pageintegerOptional

Current page

limitintegerOptional

Page size

searchstringOptional

A string to be used for search. The search happens on the name and tags fields of the dApp. If this is not present, all dApps are returned.

isListedbooleanOptional

DApp is listed or not

Example: true
chainIdintegerOptional

DApp supported chainId's. Only dApps belonging to this chainID will be returned.

Example: 137
languagestringOptional

DApp's language

Example: en
matureForAudiencebooleanOptional

Mentions if the app is for all ages or only mature audience

Example: false
minAgeintegerOptional

Minimum age

Example: 13
listedOnOrAfterstring · dateOptional

The date dApp was listed on or after. Date should be in ISO format.

Example: 2021-11-13
listedOnOrBeforestring · dateOptional

The date dApp was listed on or before. Date should be in ISO format.

Example: 2021-11-13
allowedInCountriesstring[]Optional

dApp allowed countries

blockedInCountriesstring[]Optional

dApp blocked countries

orderBystringOptional

Want to get dapp by order(asc, desc) by one or more params.

Example: ["name:asc","name:desc","rating:asc","rating:desc","installs:asc","installs:desc","visits:asc","visits:desc","listDate:asc","listDate:desc"]
Responses
200
successful operation
application/json
400
Invalid status value
get
GET /dapp HTTP/1.1
Host: api-a.meroku.store
Accept: */*
{
  "page": 1,
  "limit": 1,
  "pageCount": 1,
  "response": [
    {
      "name": "My Cool NFT Creator dApp",
      "description": "A really cool NFT Creator dApp",
      "appUrl": "https://www.example.com",
      "images": {
        "logo": "https://example.com/logo.png",
        "banner": "https://www.example.com/banner.png",
        "screenshots": [
          "https://www.example.com/screenshot_1.png",
          "https://www.example.com/screenshot_2.png"
        ]
      },
      "repoUrl": "https://example.com",
      "dappId": "example.store.dapp",
      "minAge": 13,
      "isForMatureAudience": false,
      "isSelfModerated": true,
      "language": "en",
      "version": "0.1.0",
      "isListed": true,
      "listDate": "2021-11-13",
      "availableOnPlatform": [
        "web"
      ],
      "geoRestrictions": {
        "allowedCountries": [
          "US",
          "IN"
        ],
        "blockedCountries": [
          "CN"
        ]
      },
      "developer": {
        "legalName": "John Doe & Sons",
        "logo": "https://www.example.com/logo_small.png",
        "website": "https://www.example.com",
        "privacyPolicyUrl": "https://www.example.com/privacy",
        "support": {
          "url": "https://www.example.com/support",
          "email": "support@example.com"
        },
        "githubID": "r488it"
      },
      "tags": [
        "nft maker"
      ],
      "chains": [
        1,
        137
      ],
      "category": "books",
      "walletApiVersion": [
        "v1",
        "v2"
      ],
      "downloadBaseUrls": [
        {
          "url": "https://ipfs.io/ipfs/qWEWEFDVSDVERGREqdyqqgQWEVSDWWDVW?filename=packageId.apk",
          "platform": "android",
          "architecture": "ARMv7-A",
          "minVersion": "11.0.0",
          "maxVersion": "14.0.0",
          "screenDPI": "text",
          "packageId": "com.packageid.app"
        }
      ],
      "contracts": [
        {
          "chainId": 1,
          "address": 0
        }
      ],
      "metrics": {
        "dappId": "mint.buidl.dapp",
        "downloads": 122872,
        "installs": 120293,
        "uninstalls": 726,
        "ratingsCount": 6872,
        "visits": 283633,
        "rating": 2.34
      }
    }
  ]
}

Add dApp

post

Adding new dApp to the store

Body
namestringRequired

The name of the developer (from GitHub)

Example: r488it
emailstringRequired

The email of the developer (from Github)

Example: name@email.org
accessTokenstringRequired

The JWT access token of the developer (from Github) for user to server API Calls

Example: ghu_clhzH0E07dPHKLCxnIC3okyITV0BVk18XwkE
githubIDstringRequired

The GitHub ID of the developer

Example: r488it
orgstringOptional

The GitHub organization to fork the repo to.

Responses
200
Successful operation
application/json
Responsestring
400
Invalid ID supplied
404
DApp not found
405
Validation exception
post
POST /dapp HTTP/1.1
Host: api-a.meroku.store
Content-Type: application/json
Accept: */*
Content-Length: 1564

{
  "name": "r488it",
  "email": "name@email.org",
  "accessToken": "ghu_clhzH0E07dPHKLCxnIC3okyITV0BVk18XwkE",
  "githubID": "r488it",
  "dapp": {
    "name": "My Cool NFT Creator dApp",
    "description": "A really cool NFT Creator dApp",
    "appUrl": "https://www.example.com",
    "images": {
      "logo": "https://example.com/logo.png",
      "banner": "https://www.example.com/banner.png",
      "screenshots": [
        "https://www.example.com/screenshot_1.png",
        "https://www.example.com/screenshot_2.png"
      ]
    },
    "repoUrl": "https://example.com",
    "dappId": "example.store.dapp",
    "minAge": 13,
    "isForMatureAudience": false,
    "isSelfModerated": true,
    "language": "en",
    "version": "0.1.0",
    "isListed": true,
    "listDate": "2021-11-13",
    "availableOnPlatform": [
      "web"
    ],
    "geoRestrictions": {
      "allowedCountries": [
        "US",
        "IN"
      ],
      "blockedCountries": [
        "CN"
      ]
    },
    "developer": {
      "legalName": "John Doe & Sons",
      "logo": "https://www.example.com/logo_small.png",
      "website": "https://www.example.com",
      "privacyPolicyUrl": "https://www.example.com/privacy",
      "support": {
        "url": "https://www.example.com/support",
        "email": "support@example.com"
      },
      "githubID": "r488it"
    },
    "tags": [
      "nft maker"
    ],
    "chains": [
      1,
      137
    ],
    "category": "books",
    "walletApiVersion": [
      "v1",
      "v2"
    ],
    "downloadBaseUrls": [
      {
        "url": "https://ipfs.io/ipfs/qWEWEFDVSDVERGREqdyqqgQWEVSDWWDVW?filename=packageId.apk",
        "platform": "android",
        "architecture": "ARMv7-A",
        "minVersion": "11.0.0",
        "maxVersion": "14.0.0",
        "screenDPI": "text",
        "packageId": "com.packageid.app"
      }
    ],
    "contracts": [
      {
        "chainId": 1,
        "address": 0
      }
    ],
    "metrics": {
      "dappId": "mint.buidl.dapp",
      "downloads": 122872,
      "installs": 120293,
      "uninstalls": 726,
      "ratingsCount": 6872,
      "visits": 283633,
      "rating": 2.34
    }
  },
  "org": "text"
}
text

Update dApp

put

For updating the existing dApp

Body
namestringRequired

The name of the developer (from GitHub)

Example: r488it
emailstringRequired

The email of the developer (from Github)

Example: name@email.org
accessTokenstringRequired

The JWT access token of the developer (from Github) for user to server API Calls

Example: ghu_clhzH0E07dPHKLCxnIC3okyITV0BVk18XwkE
githubIDstringRequired

The GitHub ID of the developer

Example: r488it
orgstringOptional

The GitHub organization to fork the repo to.

Responses
200
successful operation
application/json
Responsestring
400
Invalid ID supplied
404
DApp not found
405
Validation exception
put
PUT /dapp HTTP/1.1
Host: api-a.meroku.store
Content-Type: application/json
Accept: */*
Content-Length: 1564

{
  "name": "r488it",
  "email": "name@email.org",
  "accessToken": "ghu_clhzH0E07dPHKLCxnIC3okyITV0BVk18XwkE",
  "githubID": "r488it",
  "dapp": {
    "name": "My Cool NFT Creator dApp",
    "description": "A really cool NFT Creator dApp",
    "appUrl": "https://www.example.com",
    "images": {
      "logo": "https://example.com/logo.png",
      "banner": "https://www.example.com/banner.png",
      "screenshots": [
        "https://www.example.com/screenshot_1.png",
        "https://www.example.com/screenshot_2.png"
      ]
    },
    "repoUrl": "https://example.com",
    "dappId": "example.store.dapp",
    "minAge": 13,
    "isForMatureAudience": false,
    "isSelfModerated": true,
    "language": "en",
    "version": "0.1.0",
    "isListed": true,
    "listDate": "2021-11-13",
    "availableOnPlatform": [
      "web"
    ],
    "geoRestrictions": {
      "allowedCountries": [
        "US",
        "IN"
      ],
      "blockedCountries": [
        "CN"
      ]
    },
    "developer": {
      "legalName": "John Doe & Sons",
      "logo": "https://www.example.com/logo_small.png",
      "website": "https://www.example.com",
      "privacyPolicyUrl": "https://www.example.com/privacy",
      "support": {
        "url": "https://www.example.com/support",
        "email": "support@example.com"
      },
      "githubID": "r488it"
    },
    "tags": [
      "nft maker"
    ],
    "chains": [
      1,
      137
    ],
    "category": "books",
    "walletApiVersion": [
      "v1",
      "v2"
    ],
    "downloadBaseUrls": [
      {
        "url": "https://ipfs.io/ipfs/qWEWEFDVSDVERGREqdyqqgQWEVSDWWDVW?filename=packageId.apk",
        "platform": "android",
        "architecture": "ARMv7-A",
        "minVersion": "11.0.0",
        "maxVersion": "14.0.0",
        "screenDPI": "text",
        "packageId": "com.packageid.app"
      }
    ],
    "contracts": [
      {
        "chainId": 1,
        "address": 0
      }
    ],
    "metrics": {
      "dappId": "mint.buidl.dapp",
      "downloads": 122872,
      "installs": 120293,
      "uninstalls": 726,
      "ratingsCount": 6872,
      "visits": 283633,
      "rating": 2.34
    }
  },
  "org": "text"
}
text