API Documentation

Identity API

The Identity API enables generating fake player profiles.

Full API request example

Request

curl -X POST 'https://fmul.io/identity/v1?features=username&amount=3' \ -H 'Authorization: Bearer fmul-client-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \ -H 'Content-Type: application/json'

Response

{
  "data":[
    [{
      "feature":"username",
      "value":"MLGBigGeorge"
    }],
    [{
      "feature":"username",
      "value":"itsdel"
    }],
    [{
      "feature":"username",
      "value":"pantaah"
    }]
  ],
  "quotas":[
    {
    "feature":"username",
    "limit":500,
    "used":"6",
    "thisIncrement":3,
    "reset":11859,
    "period":"DAY"
    }
  ]
}

Headers

All requests to the Identity API require:

'Authorization: Bearer fmul-client-xxxxxxxxxxxx' - generate a client token here
'Content-Type: application/json'

Request Shape

Player features to be generated should be passed in the form of a query argument. Multiple features can be requested per identity in the form of a comma-separated list. At most 10 features may be requested per identity. If not specified, the default is a single "username" feature.

Currently available feature types include: 'username'
WIP features (not yet available) will include: 'pfp', 'nickname', 'banner', 'bio'

curl -X POST https://fmul.io/identity/v1?features=username,username,username

amount

The amount of identities should be passed in the form of a query argument. At most 100 identities may be requested at once. If not specified, the default amount is 1.

curl -X POST https://fmul.io/identity/v1?amount=5

Response Shape

data

A JSON-formatted list of player identities.
Each player identity is a list of features.
Each feature is an object with a 'feature' attribute and a 'value' attribute

'feature' = the type of this feature
'value' = a randomly chosen value of this feature type

quota

A list of quota objects describing how many feature requests the account has available to them.

'feature' = the feature this quota object is for
'limit' = the maximum amount of this feature that can be served to your account for this quota period.
'used' = how many requests for this feature your account has already performed for this quota period.
'thisIncrement' = how many requests for this feature this specific API call consumed.
'reset' = the remaining time in seconds until the quota for this feature resets.
'period' = the time period between quota resets. Can be either DAY or MONTH

For questions on how to use the Identity API, reach out to support AT fakemultiplayer dot com!