API Documentation

Introduction

• All the API calls require a pair of API access & secret keys. Please fill out this form if you wish to get your API keys today. After your account is created, you can log in to the Partner Dashboard.

• Currently, there is only one API endpoint which is [<https://api.reputex.io/v1>](<https://api.reputex.io/v1>) .

Making the API Calls

• The API access keys and secret key must be included in all the requests, in the following manner:

{
    "X-API-Key": <Insert access key>,
    "X-API-Secret": <Insert secret key>
};

• Sample CURL request

  curl -X 'GET'   '<https://api.reputex.io/v1/score/exists/0x6C2A780F93Ec560775133f3Ed2ae669744Fe0f49>' \\ 
  -H 'x-api-key: <insert access key>'
  -H 'x-api-secret : <insert secret key>'

Fetch the score for the address

This API endpoint returns the score for the address provided.

Request

GET /score/breakdown/:addressOrDomain

Query Parameters:

addressOrDomain: The address or the domain must be included as a route param.

Response

{
    "success": true,
    "data": {
        "address": "0x32cb9fd13af7635cc90d0713a80188b366a28205",
        "reputeXScore": 48.12,
        "legacyReputeXScore": 617.36,
        "customScore": 48.12,
        "blacklisted": false,
        "lastUpdated": "2024-07-19T06:32:50.031Z",
        "scoreBreakdown": {
            "ethereum": {
                "finalScore": 16,
                "ethereumContribution": 53.15,
                "defiCategoryScore": {
                    "finalScore": 11,
                    "aaveScore": 1,
                    "compoundScore": 0,
                    "tvlScore": 28,
                    "curveScore": 0,
                    "enzymeScore": 0,
                    "eulerScore": 0,
                    "lidoScore": 8,
                    "uniswapScore": 24,
                    "yearnScore": 0,
                    "ironBankScore": 0,
                    "riskScore": 0,
                    "eigenLayerScore": 42
                },
                "credibilityCategoryScore": {
                    "finalScore": 40,
                    "appsInteractionScore": 34,
                    "ensScore": 90,
                    "txHistoryScore": 60,
                    "udScore": 0,
                    "gitcoinScore": 20,
                    "fsaScore": 38
                },
                "metaCategoryScore": {
                    "finalScore": 3,
                    "metaverseScore": 0,
                    "nftScore": 0,
                    "nftTradingScore": 18,
                    "poolTogetherScore": 0,
                    "sandboxScore": 0
                },
                "socialImpactScore": {
                    "finalScore": 0,
                    "uniswapDaoScore": 0
                }
            },
            "polygon": {
                "finalScore": 27,
                "polygonContribution": 9.79,
                "defiCategoryScore": {
                    "finalScore": 18,
                    "aaveScore": 7,
                    "tvlScore": 16,
                    "riskScore": 0,
                    "uniswapScore": 34
                },
                "credibilityCategoryScore": {
                    "finalScore": 47,
                    "appsInteractionScore": 80,
                    "txHistoryScore": 72,
                    "udScore": 0,
                    "fsaScore": 28
                },
                "metaCategoryScore": {
                    "finalScore": 0,
                    "nftScore": 0,
                    "poolTogetherScore": 0,
                    "sandboxScore": 0
                },
                "socialImpactScore": {
                    "finalScore": 0
                }
            },
            "bsc": {
                "finalScore": 23,
                "binanceContribution": 6.29,
                "defiCategoryScore": {
                    "finalScore": 9,
                    "tvlScore": 14,
                    "venusScore": 0
                },
                "credibilityCategoryScore": {
                    "finalScore": 45,
                    "appsInteractionScore": 60,
                    "txHistoryScore": 64,
                    "fsaScore": 18
                },
                "metaCategoryScore": {
                    "finalScore": 0,
                    "nftScore": 0
                },
                "socialImpactScore": {
                    "finalScore": 0
                }
            },
            "avalanche": {
                "finalScore": 15,
                "avalancheContribution": 2.8,
                "defiCategoryScore": {
                    "finalScore": 1,
                    "aaveScore": 2,
                    "tvlScore": 0
                },
                "credibilityCategoryScore": {
                    "finalScore": 38,
                    "appsInteractionScore": 42,
                    "txHistoryScore": 62,
                    "fsaScore": 12
                },
                "metaCategoryScore": {
                    "finalScore": 0,
                    "nftScore": 0,
                    "poolTogetherScore": 0
                },
                "socialImpactScore": {
                    "finalScore": 0
                }
            },
            "arbitrum": {
                "finalScore": 18,
                "arbitrumContribution": 6.29,
                "defiCategoryScore": {
                    "finalScore": 11,
                    "aaveScore": 0,
                    "tvlScore": 22,
                    "uniswapScore": 44,
                    "yearnScore": 0,
                    "abracadabraScore": 0,
                    "siloFinanceScore": 0,
                    "qiDaoScore": 0
                },
                "credibilityCategoryScore": {
                    "finalScore": 46,
                    "appsInteractionScore": 32,
                    "txHistoryScore": 64,
                    "fsaScore": 36
                },
                "metaCategoryScore": {
                    "finalScore": 0,
                    "nftScore": 0
                }
            },
            "optimism": {
                "finalScore": 23,
                "optimismContribution": 4.9,
                "defiCategoryScore": {
                    "finalScore": 11,
                    "aaveScore": 2,
                    "tvlScore": 15,
                    "uniswapScore": 30,
                    "qiDaoScore": 0,
                    "sushiSwapScore": 0,
                    "curveScore": 8,
                    "sonneFinanceScore": 20
                },
                "credibilityCategoryScore": {
                    "finalScore": 44,
                    "appsInteractionScore": 60,
                    "txHistoryScore": 68,
                    "fsaScore": 6
                },
                "metaCategoryScore": {
                    "finalScore": 56,
                    "farcasterScore": 56
                }
            },
            "base": {
                "finalScore": 33,
                "baseContribution": 4.2,
                "defiCategoryScore": {
                    "finalScore": 24,
                    "tvlScore": 11,
                    "aaveScore": 66,
                    "uniswapScore": 32,
                    "sushiSwapScore": 0
                },
                "credibilityCategoryScore": {
                    "finalScore": 46,
                    "appsInteractionScore": 66,
                    "txHistoryScore": 72,
                    "fsaScore": 6
                }
            },
            "moonbeam": {
                "finalScore": 21,
                "moonbeamContribution": 2.8,
                "defiCategoryScore": {
                    "finalScore": 20,
                    "tvlScore": 47,
                    "curveScore": 0,
                    "sushiSwapScore": 8,
                    "moonwellScore": 0
                },
                "credibilityCategoryScore": {
                    "finalScore": 30,
                    "appsInteractionScore": 0,
                    "txHistoryScore": 46,
                    "fsaScore": 28
                },
                "socialImpactScore": {
                    "finalScore": 0,
                    "moonwellDaoScore": 0
                }
            },
            "linea": {
                "finalScore": 23,
                "lineaContribution": 4.2,
                "defiCategoryScore": {
                    "finalScore": 20,
                    "tvlScore": 15,
                    "pancakeSwapScore": 22,
                    "sushiSwapScore": 6,
                    "syncSwapScore": 48,
                    "nileExchangeScore": 0,
                    "iZiSwapScore": 54,
                    "zeroLendScore": 2
                },
                "credibilityCategoryScore": {
                    "finalScore": 45,
                    "appsInteractionScore": 82,
                    "txHistoryScore": 64,
                    "fsaScore": 6
                },
                "metaCategoryScore": {
                    "finalScore": 0,
                    "nftScore": 0
                }
            },
            "zkSyncEra": {
                "finalScore": 40,
                "zkSyncEraContribution": 5.59,
                "defiCategoryScore": {
                    "finalScore": 36,
                    "tvlScore": 15,
                    "pancakeSwapScore": 26,
                    "syncSwapScore": 56,
                    "koiFinanceScore": 76,
                    "iZiSwapScore": 28
                },
                "credibilityCategoryScore": {
                    "finalScore": 48,
                    "appsInteractionScore": 100,
                    "txHistoryScore": 64,
                    "fsaScore": 6
                }
            }
        },
        "syncBlockNumber": {
            "ethereum": 20338800,
            "polygon": 59540288,
            "bsc": 40602051,
            "avalanche": 48156025,
            "arbitrum": 233750109,
            "optimism": 122885925,
            "base": 17290694,
            "moonbeam": 6645758,
            "linea": 6983742,
            "zkSyncEra": 39474682
        }
    },
    "message": "ReputeX Score exists for the address.",
    "error": ""
}

Create the score for the address

This API endpoint generates and stores the score for the address provided.

Request

POST /score/create/:addressOrDomain

Query Parameters:

addressOrDomain: The address or the domain must be included as a route param.

Response if the score doesn't exist

{
    "success": true,
    "data": {
        "didResolved": false,
        "did": "",
        "addressWiseStatus": [
            {
                "address": "0x643bb72735e4912bd1a194a1c1517a5dcedbbfa8",
                "success": true,
                "message": "Score successfully updated!"
            }
        ]
    },
    "message": "OK",
    "error": ""
}

Response if the score exists

{
    "success": false,
    "data": null,
    "message": "ReputeX Score already exists for given address.",
    "error": ""
}

Update the score for the address

This API endpoint updates the score for the address provided.

Request

POST /score/update/:addressOrDomain

Parameters:

addressOrDomain: The address or the domain must be included as a route param.

Response

{
    "success": true,
    "data": {
        "score": 46.77,
        "legacyReputeXScore": 615.48
    },
    "message": "Score successfully updated!",
    "error": ""
}

Response if the score does not exist

{
    "success": false,
    "data": null,
    "message": "ReputeX Score does not exist for given address.",
    "error": ""
}

Fetch the HODL Score for the Address

This API endpoint fetches the HODL score for the address provided.

Request

GET /hodl/breakdown/:addressOrDomain

Parameters:

addressOrDomain: The address or the domain must be included as a route param.

Response if the score exists

{
    "success": true,
    "data": {
        "createdAt": "2024-08-20T06:43:18.627Z",
        "hodlScore": {
            "OneInch": [
                {
                    "network": "BSC",
                    "finalScore": "-3",
                    "hodlScore": "-3",
                    "hodlComputedData": {
                        "lowestBal": {
                            "index": 3,
                            "balance": 0,
                            "duration": 518
                        },
                        "totalDays": 1062,
                        "avgBalance": 14482442162801.254,
                        "highestBal": {
                            "index": 5,
                            "balance": 43353652853448720000,
                            "duration": 0
                        },
                        "firstTxDate": "2021-09-23T07:42:06.000Z",
                        "currentBalance": 0,
                        "zeroBalanceStats": {
                            "days": 1061,
                            "count": 5
                        },
                        "totalActiveBalanceDays": 1
                    },
                    "hodlCoreHodlScore": 3,
                    "hodlCurrentBalanceScore": 0,
                    "hodlZeroBalanceScore": -11,
                    "hodlHighestBalanceScore": 4,
                    "hodlLowestBalanceScore": 1,
                    "stakedScore": "0",
                    "stakedComputedData": {},
                    "stakedCoreHodlScore": null,
                    "stakedCurrentBalanceScore": null,
                    "stakedZeroBalanceScore": null,
                    "stakedHighestBalanceScore": null,
                    "stakedLowestBalanceScore": null
                }
            ],
            "Compound": [
                {
                    "network": "Ethereum",
                    "finalScore": "2",
                    "hodlScore": "2",
                    "hodlComputedData": {
                        "lowestBal": {
                            "index": 1,
                            "balance": 0,
                            "duration": 520
                        },
                        "totalDays": 520,
                        "avgBalance": 0,
                        "highestBal": {
                            "index": 0,
                            "balance": 185402503061605730,
                            "duration": 0
                        },
                        "firstTxDate": "2023-03-19T10:34:47.000Z",
                        "currentBalance": 0,
                        "zeroBalanceStats": {
                            "days": 520,
                            "count": 1
                        },
                        "totalActiveBalanceDays": 0
                    },
                    "hodlCoreHodlScore": 0,
                    "hodlCurrentBalanceScore": 0,
                    "hodlZeroBalanceScore": -7,
                    "hodlHighestBalanceScore": 4,
                    "hodlLowestBalanceScore": 5,
                    "stakedScore": "0",
                    "stakedComputedData": {},
                    "stakedCoreHodlScore": null,
                    "stakedCurrentBalanceScore": null,
                    "stakedZeroBalanceScore": null,
                    "stakedHighestBalanceScore": null,
                    "stakedLowestBalanceScore": null
                }
            ],
            "Curve": [
                {
                    "network": "Ethereum",
                    "finalScore": "-6.4",
                    "hodlScore": "-8",
                    "hodlComputedData": {
                        "lowestBal": {
                            "index": 2,
                            "balance": 0,
                            "duration": 123
                        },
                        "totalDays": 520,
                        "avgBalance": 9780543204735316000,
                        "highestBal": {
                            "index": 3,
                            "balance": 14594163580430404000,
                            "duration": 1
                        },
                        "firstTxDate": "2023-03-19T10:34:47.000Z",
                        "currentBalance": 0,
                        "zeroBalanceStats": {
                            "days": 519,
                            "count": 6
                        },
                        "totalActiveBalanceDays": 1
                    },
                    "hodlCoreHodlScore": 3,
                    "hodlCurrentBalanceScore": 0,
                    "hodlZeroBalanceScore": -13,
                    "hodlHighestBalanceScore": 1,
                    "hodlLowestBalanceScore": 1,
                    "stakedScore": "0",
                    "stakedComputedData": null,
                    "stakedCoreHodlScore": 0,
                    "stakedCurrentBalanceScore": 0,
                    "stakedZeroBalanceScore": 0,
                    "stakedHighestBalanceScore": 0,
                    "stakedLowestBalanceScore": 0
                },
                {
                    "network": "Polygon",
                    "finalScore": "-3",
                    "hodlScore": "-3",
                    "hodlComputedData": {
                        "lowestBal": {
                            "index": 1,
                            "balance": 0,
                            "duration": 272
                        },
                        "totalDays": 519,
                        "avgBalance": 228080611562219400,
                        "highestBal": {
                            "index": 2,
                            "balance": 236281344133602970000,
                            "duration": 0
                        },
                        "firstTxDate": "2023-03-20T07:07:28.000Z",
                        "currentBalance": 0,
                        "zeroBalanceStats": {
                            "days": 492,
                            "count": 7
                        },
                        "totalActiveBalanceDays": 27
                    },
                    "hodlCoreHodlScore": 3,
                    "hodlCurrentBalanceScore": 0,
                    "hodlZeroBalanceScore": -13,
                    "hodlHighestBalanceScore": 7,
                    "hodlLowestBalanceScore": 0,
                    "stakedScore": "0",
                    "stakedComputedData": {},
                    "stakedCoreHodlScore": null,
                    "stakedCurrentBalanceScore": null,
                    "stakedZeroBalanceScore": null,
                    "stakedHighestBalanceScore": null,
                    "stakedLowestBalanceScore": null
                }
            ],
            "Uniswap": [
                {
                    "network": "Ethereum",
                    "finalScore": "-4",
                    "hodlScore": "-4",
                    "hodlComputedData": {
                        "lowestBal": {
                            "index": 1,
                            "balance": 0,
                            "duration": 421
                        },
                        "totalDays": 520,
                        "avgBalance": 248116246597692540,
                        "highestBal": {
                            "index": 0,
                            "balance": 1303236850816162800,
                            "duration": 99
                        },
                        "firstTxDate": "2023-03-19T10:34:47.000Z",
                        "currentBalance": 0,
                        "zeroBalanceStats": {
                            "days": 520,
                            "count": 2
                        },
                        "totalActiveBalanceDays": 0
                    },
                    "hodlCoreHodlScore": 2,
                    "hodlCurrentBalanceScore": 0,
                    "hodlZeroBalanceScore": -8,
                    "hodlHighestBalanceScore": 2,
                    "hodlLowestBalanceScore": 0,
                    "stakedScore": "0",
                    "stakedComputedData": {},
                    "stakedCoreHodlScore": null,
                    "stakedCurrentBalanceScore": null,
                    "stakedZeroBalanceScore": null,
                    "stakedHighestBalanceScore": null,
                    "stakedLowestBalanceScore": null
                }
            ]
        }
    },
    "message": "OK",
    "error": ""
}

Response if the score does not exist

{
    "success": false,
    "data": null,
    "message": "HODL Score does not exist for given address.",
    "error": ""
}

Create or Update the HODL score for the address

This API endpoint creates or updates the HODL score for the address provided.

Request

POST /hodl/create/:addressOrDomain

Parameters:

addressOrDomain: The address or the domain must be included as a route param.

Response

 {
    "success": true,
    "data": null,
    "message": "Hodl score has been generated successfully.",
    "error": ""
}

Errors & Debugging

You are likely to receive the following error messages in case you haven’t set the API key or secret correctly in the header, please cross-check with the documentation provided.

status 401
Unauthorized, access key is not provided

status 401
Unauthorized, secret key is not provided

status 401
Unauthorized, api key or secret is not valid.

status 401
Unauthorized, access key has been disabled. Contact admin.