Dapp | API Docs

API Docs

Docs Github Support Meroku Protocol

Get dApp

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.

get

/dapp

Query parameters

pageinteger

Current page

limitinteger

Page size

searchstring

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.

isListedboolean

DApp is listed or not

Example: true

chainIdinteger

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

Example: 137

languagestring

DApp's language

Example: en

availableOnPlatformstring · enum[]

matureForAudienceboolean

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

Example: false

minAgeinteger

Minimum age

Example: 13

listedOnOrAfterstring · date

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

Example: 2021-11-13

listedOnOrBeforestring · date

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

Example: 2021-11-13

allowedInCountriesstring[]

blockedInCountriesstring[]

categoriesstring · enum[][]

orderBystring

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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api-a.meroku.store/dapp'

200

400

{
  "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",
      "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",
      "category": "books",
      "tags": [
        "nft maker"
      ],
      "chains": [
        1,
        137
      ],
      "walletApiVersion": [
        "v1",
        "v2"
      ],
      "availableOnPlatform": [
        "web"
      ],
      "metrics": {
        "dappId": "mint.buidl.dapp",
        "downloads": 122872,
        "installs": 120293,
        "uninstalls": 726,
        "ratingsCount": 6872,
        "visits": 283633,
        "rating": 2.34
      },
      "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"
        ]
      },
      "geoRestrictions": {
        "allowedCountries": [
          "US",
          "IN"
        ],
        "blockedCountries": [
          "CN"
        ]
      },
      "downloadBaseUrls": [
        {
          "url": "https://ipfs.io/ipfs/qWEWEFDVSDVERGREqdyqqgQWEVSDWWDVW?filename=packageId.apk",
          "screenDPI": "text",
          "packageId": "com.packageid.app",
          "platform": "android",
          "architecture": "ARMv7-A",
          "minVersion": "11.0.0",
          "maxVersion": "14.0.0"
        }
      ],
      "contracts": [
        {
          "address": 0,
          "chainId": 1
        }
      ],
      "developer": {
        "legalName": "John Doe & Sons",
        "logo": "https://www.example.com/logo_small.png",
        "website": "https://www.example.com",
        "privacyPolicyUrl": "https://www.example.com/privacy",
        "githubID": "r488it",
        "support": {
          "url": "https://www.example.com/support",
          "email": "support@example.com"
        }
      }
    }
  ]
}

successful operation

Add dApp

Adding new dApp to the store

post

/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

dappobjectrequired

orgstring

The GitHub organization to fork the repo to.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api-a.meroku.store/dapp' \
  --header 'Content-Type: application/json' \
  --data '{
    "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",
      "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",
      "category": "books",
      "tags": [
        "nft maker"
      ],
      "chains": [
        1,
        137
      ],
      "walletApiVersion": [
        "v1",
        "v2"
      ],
      "availableOnPlatform": [
        "web"
      ],
      "metrics": {
        "dappId": "mint.buidl.dapp",
        "downloads": 122872,
        "installs": 120293,
        "uninstalls": 726,
        "ratingsCount": 6872,
        "visits": 283633,
        "rating": 2.34
      },
      "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"
        ]
      },
      "geoRestrictions": {
        "allowedCountries": [
          "US",
          "IN"
        ],
        "blockedCountries": [
          "CN"
        ]
      },
      "downloadBaseUrls": [
        {
          "url": "https://ipfs.io/ipfs/qWEWEFDVSDVERGREqdyqqgQWEVSDWWDVW?filename=packageId.apk",
          "screenDPI": "text",
          "packageId": "com.packageid.app",
          "platform": "android",
          "architecture": "ARMv7-A",
          "minVersion": "11.0.0",
          "maxVersion": "14.0.0"
        }
      ],
      "contracts": [
        {
          "address": 0,
          "chainId": 1
        }
      ],
      "developer": {
        "legalName": "John Doe & Sons",
        "logo": "https://www.example.com/logo_small.png",
        "website": "https://www.example.com",
        "privacyPolicyUrl": "https://www.example.com/privacy",
        "githubID": "r488it",
        "support": {
          "url": "https://www.example.com/support",
          "email": "support@example.com"
        }
      }
    },
    "org": "text"
  }'

200

400

404

405

text

Successful operation

Update dApp

For updating the existing dApp

put

/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

dappobjectrequired

orgstring

The GitHub organization to fork the repo to.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api-a.meroku.store/dapp' \
  --header 'Content-Type: application/json' \
  --data '{
    "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",
      "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",
      "category": "books",
      "tags": [
        "nft maker"
      ],
      "chains": [
        1,
        137
      ],
      "walletApiVersion": [
        "v1",
        "v2"
      ],
      "availableOnPlatform": [
        "web"
      ],
      "metrics": {
        "dappId": "mint.buidl.dapp",
        "downloads": 122872,
        "installs": 120293,
        "uninstalls": 726,
        "ratingsCount": 6872,
        "visits": 283633,
        "rating": 2.34
      },
      "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"
        ]
      },
      "geoRestrictions": {
        "allowedCountries": [
          "US",
          "IN"
        ],
        "blockedCountries": [
          "CN"
        ]
      },
      "downloadBaseUrls": [
        {
          "url": "https://ipfs.io/ipfs/qWEWEFDVSDVERGREqdyqqgQWEVSDWWDVW?filename=packageId.apk",
          "screenDPI": "text",
          "packageId": "com.packageid.app",
          "platform": "android",
          "architecture": "ARMv7-A",
          "minVersion": "11.0.0",
          "maxVersion": "14.0.0"
        }
      ],
      "contracts": [
        {
          "address": 0,
          "chainId": 1
        }
      ],
      "developer": {
        "legalName": "John Doe & Sons",
        "logo": "https://www.example.com/logo_small.png",
        "website": "https://www.example.com",
        "privacyPolicyUrl": "https://www.example.com/privacy",
        "githubID": "r488it",
        "support": {
          "url": "https://www.example.com/support",
          "email": "support@example.com"
        }
      }
    },
    "org": "text"
  }'

200

400

404

405

text

successful operation