{
  "opencollection": "1.0.0",
  "info": {
    "name": "Paxos Account Members Profiles API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "Profiles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Profiles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.paxos.com/v2/profiles",
            "params": [
              {
                "name": "created_at.lt",
                "value": "",
                "type": "query",
                "description": "Include timestamps strictly less than lt. RFC3339 format, like `2006-01-02T15:04:05Z`."
              },
              {
                "name": "created_at.lte",
                "value": "",
                "type": "query",
                "description": "Include timestamps less than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`."
              },
              {
                "name": "created_at.eq",
                "value": "",
                "type": "query",
                "description": "Include timestamps exactly equal to eq. RFC3339 format, like `2006-01-02T15:04:05Z`."
              },
              {
                "name": "created_at.gte",
                "value": "",
                "type": "query",
                "description": "Include timestamps greater than or equal to gte. RFC3339 format, like `2006-01-02T15:04:05Z`."
              },
              {
                "name": "created_at.gt",
                "value": "",
                "type": "query",
                "description": "Include timestamps strictly greater than gt. RFC3339 format, like `2006-01-02T15:04:05Z`."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results to return."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Return items in ascending (ASC) or descending (DESC) order. Defaults to ASC."
              },
              {
                "name": "order_by",
                "value": "",
                "type": "query",
                "description": "The specific method by which the returned results will be ordered."
              },
              {
                "name": "page_cursor",
                "value": "",
                "type": "query",
                "description": "Cursor token for fetching the next page."
              },
              {
                "name": "nickname",
                "value": "",
                "type": "query",
                "description": "Optionally filter by Profile display name. Retrieves nickname(s) based on the beginning characters of the given display name (prefix matching). Case insensitive. WIldcards and regular expressions not supported."
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Optionally filter by the UUIDs of the profiles. Limit 100."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.paxos.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Return the associated Profiles for the current Account.\nThe paginated results default to the maximum limit of 1,000 Profiles, unless otherwise specified with the `limit` parameter.\nEvery paginated response contains a `next_page` field until the last page is reached.\nPass the `next_page` value into the `page_cursor` field of the next request to retrieve the next page of results."
        },
        {
          "info": {
            "name": "Create Profile",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.paxos.com/v2/profiles",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.paxos.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create a new profile for this account. Profiles created using this endpoint always have a type of `NORMAL`."
        },
        {
          "info": {
            "name": "Get Profile",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.paxos.com/v2/profiles/:profile_id",
            "params": [
              {
                "name": "profile_id",
                "value": "",
                "type": "path",
                "description": "The UUID of the profile, or \"default\" for the default profile."
              },
              {
                "name": "include_deactivated",
                "value": "",
                "type": "query",
                "description": "Used to include deactivated profiles in the response."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.paxos.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Read a single profile by its UUID, or read the default profile using the alias \"default\"."
        },
        {
          "info": {
            "name": "Update Profile",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.paxos.com/v2/profiles/:profile_id",
            "params": [
              {
                "name": "profile_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.paxos.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Change the `nickname` label for the given `profile_id` (Profile)."
        },
        {
          "info": {
            "name": "List Profile Balances",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.paxos.com/v2/profiles/:profile_id/balances",
            "params": [
              {
                "name": "profile_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "assets",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.paxos.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieve the Profile’s available and trading balances.\nUse query parameters to retrieve a defined set of assets.\nOmit query parameters to retrieve all asset balances."
        },
        {
          "info": {
            "name": "Get Profile Balance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.paxos.com/v2/profiles/:profile_id/balances/:asset",
            "params": [
              {
                "name": "profile_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "asset",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.paxos.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get the balance of `asset` in a profile."
        },
        {
          "info": {
            "name": "Deactivate Profile",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.paxos.com/v2/profiles/:profile_id/deactivate",
            "params": [
              {
                "name": "profile_id",
                "value": "",
                "type": "path",
                "description": "The UUID of the profile.\nThe default profile cannot be deactivated.\nThe profile must have a zero balance to be deactivated."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.paxos.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Deactivate the given `profile_id`. The default profile cannot be deactivated.\nDeactivated profiles won't be visible for deposits.\nProfiles with more than zero balances cannot be deactivated.\nIf a deactivated profile has a non-zero balance it will be reactivated."
        }
      ]
    }
  ],
  "bundled": true
}